Skip to content

Commit acb73b7

Browse files
loong10kloong10k
committed
fix: swagger2markup 及文档插件移入 docs profile（其传递依赖已随 jcenter 消失）
- swagger2markup 工程依赖与 swagger2markup/asciidoctor 插件整体移入 docs profile，默认构建不再解析 jcenter 时代的死构件 （nl.jworks.markdown_to_asciidoc、ch.netzwerg:paleo-core） - DemoApplicationTests 中依赖 swagger2markup 的演示方法/imports 注释掉， 保留代码供 docs profile 参考使用
1 parent 99d53f4 commit acb73b7

2 files changed

Lines changed: 80 additions & 74 deletions

File tree

‎spring-boot-sample-swagger2/pom.xml‎

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -116,13 +116,6 @@
116116
<artifactId>swagger-spring-boot-starter</artifactId>
117117
<version>${spring-boot-starter-swagger.version}</version>
118118
</dependency>
119-
<!-- https://mvnrepository.com/artifact/io.github.swagger2markup/swagger2markup -->
120-
<dependency>
121-
<groupId>io.github.swagger2markup</groupId>
122-
<artifactId>swagger2markup</artifactId>
123-
<version>${swagger2markup.version}</version>
124-
</dependency>
125-
126119
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
127120
<dependency>
128121
<groupId>io.springfox</groupId>
@@ -292,6 +285,27 @@
292285
<artifactId>docker-maven-plugin</artifactId> </plugin> -->
293286

294287

288+
</plugins>
289+
</build>
290+
291+
<!-- 启用 API 文档生成：需先启动应用（提供 /v2/api-docs），再执行 mvn -P docs package -->
292+
<profiles>
293+
<profile>
294+
<id>docs</id>
295+
<properties>
296+
<swagger2markup.skip>false</swagger2markup.skip>
297+
<asciidoctor.skip>false</asciidoctor.skip>
298+
</properties>
299+
<dependencies>
300+
<!-- swagger2markup 及其传递依赖（markdown_to_asciidoc 等）仅文档生成时需要 -->
301+
<dependency>
302+
<groupId>io.github.swagger2markup</groupId>
303+
<artifactId>swagger2markup</artifactId>
304+
<version>${swagger2markup.version}</version>
305+
</dependency>
306+
</dependencies>
307+
<build>
308+
<plugins>
295309
<!--
296310
https://mp.weixin.qq.com/s?__biz=MzAxODcyNjEzNQ==&mid=2247484764&idx=1&sn=10e4fcae5333687368960a2e64b2b70c&chksm=9bd0a8c4aca721d264e40f5f543b9f557eedf033719a97a38257835c5162ffa010c025580a65&scene=21#wechat_redirect
297311
https://github.com/tianqing2117/swagger-doc-demo/blob/master/pom.xml
@@ -422,17 +436,8 @@
422436
</execution> -->
423437
</executions>
424438
</plugin>
425-
</plugins>
426-
</build>
427-
428-
<!-- 启用 API 文档生成：需先启动应用（提供 /v2/api-docs），再执行 mvn -P docs package -->
429-
<profiles>
430-
<profile>
431-
<id>docs</id>
432-
<properties>
433-
<swagger2markup.skip>false</swagger2markup.skip>
434-
<asciidoctor.skip>false</asciidoctor.skip>
435-
</properties>
439+
</plugins>
440+
</build>
436441
</profile>
437442
</profiles>
438443

‎spring-boot-sample-swagger2/src/test/java/swagger2/spring/boot/DemoApplicationTests.java‎

Lines changed: 57 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@
2323
import org.springframework.boot.test.context.SpringBootTest;
2424
import org.springframework.test.context.junit4.SpringRunner;
2525

26-
import io.github.swagger2markup.Swagger2MarkupConfig;
27-
import io.github.swagger2markup.Swagger2MarkupConverter;
28-
import io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder;
29-
import io.github.swagger2markup.markup.builder.MarkupLanguage;
26+
// import io.github.swagger2markup.Swagger2MarkupConfig;
27+
// import io.github.swagger2markup.Swagger2MarkupConverter;
28+
// import io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder;
29+
// import io.github.swagger2markup.markup.builder.MarkupLanguage;
3030

3131
/**
3232
* TODO
@@ -37,83 +37,84 @@
3737
//@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
3838
public class DemoApplicationTests {
3939

40-
/**
41-
* 生成AsciiDoc的代码片段：
42-
* https://blog.csdn.net/qq_35873847/article/details/79191848
43-
*/
44-
//@Test
45-
public void buildAsciiDoc() throws Exception {
40+
// 以下 swagger2markup 演示方法依赖 docs profile 提供的构件，默认不参与编译
41+
// /**
42+
// * 生成AsciiDoc的代码片段：
43+
// * https://blog.csdn.net/qq_35873847/article/details/79191848
44+
// */
45+
// //@Test
46+
// public void buildAsciiDoc() throws Exception {
4647

47-
// 输出Ascii格式
48-
49-
/*
50-
*
51-
* MarkupLanguage.ASCIIDOC：指定了要输出的最终格式。除了ASCIIDOC之外，还有MARKDOWN和CONFLUENCE_MARKUP
52-
* from(new URL("http://localhost:8080/v2/api-docs")：指定了生成静态部署文档的源头配置，可以是这样的URL形式，也可以是符合Swagger规范的String类型或者从文件中读取的流。如果是对当前使用的Swagger项目，我们通过使用访问本地Swagger接口的方式，如果是从外部获取的Swagger文档配置文件，就可以通过字符串或读文件的方式
53-
* toFolder(Paths.get("src/docs/asciidoc/generated")：指定最终生成文件的具体目录位置
54-
*
55-
*/
48+
// // 输出Ascii格式
5649

57-
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
50+
// /*
51+
// *
52+
// * MarkupLanguage.ASCIIDOC：指定了要输出的最终格式。除了ASCIIDOC之外，还有MARKDOWN和CONFLUENCE_MARKUP
53+
// * from(new URL("http://localhost:8080/v2/api-docs")：指定了生成静态部署文档的源头配置，可以是这样的URL形式，也可以是符合Swagger规范的String类型或者从文件中读取的流。如果是对当前使用的Swagger项目，我们通过使用访问本地Swagger接口的方式，如果是从外部获取的Swagger文档配置文件，就可以通过字符串或读文件的方式
54+
// * toFolder(Paths.get("src/docs/asciidoc/generated")：指定最终生成文件的具体目录位置
55+
// *
56+
// */
5857

59-
.withMarkupLanguage(MarkupLanguage.ASCIIDOC)
58+
// Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
6059

61-
.build();
60+
// .withMarkupLanguage(MarkupLanguage.ASCIIDOC)
6261

63-
Swagger2MarkupConverter.from(new URL("http://localhost:8080/v2/api-docs"))
62+
// .build();
6463

65-
.withConfig(config)
64+
// Swagger2MarkupConverter.from(new URL("http://localhost:8080/v2/api-docs"))
6665

67-
.build()
66+
// .withConfig(config)
6867

69-
.toFolder(Paths.get("src/docs/asciidoc/generated"));
68+
// .build()
7069

71-
}
70+
// .toFolder(Paths.get("src/docs/asciidoc/generated"));
7271

73-
/**
74-
* 生成confluence的代码片段：
75-
* https://blog.csdn.net/qq_35873847/article/details/79191971
76-
*/
77-
//@Test
78-
public void buildMarkdown() throws Exception {
72+
// }
7973

80-
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
74+
// /**
75+
// * 生成confluence的代码片段：
76+
// * https://blog.csdn.net/qq_35873847/article/details/79191971
77+
// */
78+
// //@Test
79+
// public void buildMarkdown() throws Exception {
8180

82-
.withMarkupLanguage(MarkupLanguage.MARKDOWN)
81+
// Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
8382

84-
.build();
83+
// .withMarkupLanguage(MarkupLanguage.MARKDOWN)
8584

86-
Swagger2MarkupConverter.from(new URL("http://localhost:8080/v2/api-docs"))
85+
// .build();
8786

88-
.withConfig(config)
87+
// Swagger2MarkupConverter.from(new URL("http://localhost:8080/v2/api-docs"))
8988

90-
.build()
89+
// .withConfig(config)
9190

92-
.toFolder(Paths.get("src/docs/confluence/generated"));
91+
// .build()
9392

94-
}
95-
96-
/**
97-
* 生成confluence的代码片段：
98-
* https://blog.csdn.net/qq_35873847/article/details/79191971
99-
*/
100-
//@Test
101-
public void buildConfluence() throws Exception {
93+
// .toFolder(Paths.get("src/docs/confluence/generated"));
10294

103-
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
95+
// }
10496

105-
.withMarkupLanguage(MarkupLanguage.CONFLUENCE_MARKUP)
97+
// /**
98+
// * 生成confluence的代码片段：
99+
// * https://blog.csdn.net/qq_35873847/article/details/79191971
100+
// */
101+
// //@Test
102+
// public void buildConfluence() throws Exception {
106103

107-
.build();
104+
// Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
108105

109-
Swagger2MarkupConverter.from(new URL("http://localhost:8080/v2/api-docs"))
106+
// .withMarkupLanguage(MarkupLanguage.CONFLUENCE_MARKUP)
110107

111-
.withConfig(config)
108+
// .build();
112109

113-
.build()
110+
// Swagger2MarkupConverter.from(new URL("http://localhost:8080/v2/api-docs"))
114111

115-
.toFolder(Paths.get("src/docs/confluence/generated"));
112+
// .withConfig(config)
116113

117-
}
114+
// .build()
115+
116+
// .toFolder(Paths.get("src/docs/confluence/generated"));
117+
118+
// }
118119

119120
}

0 commit comments

Comments
 (0)