smark doc api文档生成器插件

1、pom.xml 文件导入插入包

 

1. <?xml version="1.0" encoding="UTF-8"?>
2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
4.     <modelVersion>4.0.0</modelVersion>
5.     <parent>
6.         <groupId>org.springframework.boot</groupId>
7.         <artifactId>spring-boot-starter-parent</artifactId>
8.         <version>2.5.6</version>
9.         <relativePath/>
10.     </parent>
11.     <groupId>com.tring</groupId>
12.     <artifactId>ysyn</artifactId>
13.     <version>0.0.1-SNAPSHOT</version>
14.     <name>ysyn</name>
15.     <description>ysyn</description>
16.     <properties>
17.         <java.version>1.8</java.version>
18.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
19.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
20.         <spring-boot.version>2.3.7.RELEASE</spring-boot.version>
21.         <jjwt.version>0.9.0</jjwt.version>
22.         <alibaba-druid-version>1.2.6</alibaba-druid-version>
23.         <jwt.version>1.0.9.RELEASE</jwt.version>
24.         <fastjson.version>1.2.68</fastjson.version>
25.         <commons-io.version>2.6</commons-io.version>
26.         <mybatis-plus.version>3.4.2</mybatis-plus.version>
27.         <mybatis-plus-generator.version>3.4.1</mybatis-plus-generator.version>
28.         <velocity.version>1.7</velocity.version>
29.         <sa-token.version>1.27.0</sa-token.version>
30.         <mybatis-plus-extension>3.5.2</mybatis-plus-extension>
31.     </properties>
32.     <dependencies>
34.         
35.         <dependency>
36.             <groupId>org.springframework.boot</groupId>
37.             <artifactId>spring-boot-starter-web</artifactId>
38.         </dependency>
40.         <dependency>
41.             <groupId>org.springframework.boot</groupId>
42.             <artifactId>spring-boot-devtools</artifactId>
43.             <scope>runtime</scope>
44.             <optional>true</optional>
45.         </dependency>
47.         <dependency>
48.             <groupId>org.springframework.boot</groupId>
49.             <artifactId>spring-boot-starter-test</artifactId>
50.             <scope>test</scope>
51.         </dependency>
53.         <dependency>
54.             <groupId>org.springframework.boot</groupId>
55.             <artifactId>spring-boot-starter-validation</artifactId>
56.         </dependency>
58.         
59.         <dependency>
60.             <groupId>org.projectlombok</groupId>
61.             <artifactId>lombok</artifactId>
62.             <optional>true</optional>
63.         </dependency>
65.         
66.         <dependency>
67.             <groupId>mysql</groupId>
68.             <artifactId>mysql-connector-java</artifactId>
69.             <scope>runtime</scope>
70.         </dependency>
72.         
73.         <dependency>
74.             <groupId>com.alibaba</groupId>
75.             <artifactId>druid</artifactId>
76.             <version>${alibaba-druid-version}</version>
77.         </dependency>
79.         
80.         <dependency>
81.             <groupId>com.baomidou</groupId>
82.             <artifactId>mybatis-plus-boot-starter</artifactId>
83.             <version>${mybatis-plus.version}</version>
84.         </dependency>
86.         
87.         <dependency>
88.             <groupId>com.baomidou</groupId>
89.             <artifactId>mybatis-plus-extension</artifactId>
90.             <version>${mybatis-plus-extension}</version>
91.         </dependency>
93.         
94.         <dependency>
95.             <groupId>com.baomidou</groupId>
96.             <artifactId>mybatis-plus-generator</artifactId>
97.             <version>${mybatis-plus-generator.version}</version>
98.         </dependency>
99.         
100.         <dependency>
101.             <groupId>org.apache.velocity</groupId>
102.             <artifactId>velocity</artifactId>
103.             <version>${velocity.version}</version>
104.         </dependency>
106.         
107.         <dependency>
108.             <groupId>org.apache.commons</groupId>
109.             <artifactId>commons-lang3</artifactId>
110.         </dependency>
112.         
113.         <dependency>
114.             <groupId>com.alibaba</groupId>
115.             <artifactId>fastjson</artifactId>
116.             <version>${fastjson.version}</version>
117.         </dependency>
119.         
120.         <dependency>
121.             <groupId>org.springframework.security</groupId>
122.             <artifactId>spring-security-jwt</artifactId>
123.             <version>${jwt.version}</version>
124.         </dependency>
125.         <dependency>
126.             <groupId>io.jsonwebtoken</groupId>
127.             <artifactId>jjwt</artifactId>
128.             <version>${jjwt.version}</version>
129.         </dependency>
131.         
132.         <dependency>
133.             <groupId>cn.dev33</groupId>
134.             <artifactId>sa-token-spring-boot-starter</artifactId>
135.             <version>${sa-token.version}</version>
136.         </dependency>
137.         
138.         <dependency>
139.             <groupId>cn.dev33</groupId>
140.             <artifactId>sa-token-dao-redis-jackson</artifactId>
141.             <version>${sa-token.version}</version>
142.         </dependency>
143.         
144.         <dependency>
145.             <groupId>org.apache.commons</groupId>
146.             <artifactId>commons-pool2</artifactId>
147.         </dependency>
148.         <dependency>
149.             <groupId>org.springframework.boot</groupId>
150.             <artifactId>spring-boot-starter-websocket</artifactId>
151.         </dependency>
152.         <dependency>
153.             <groupId>com.google.zxing</groupId>
154.             <artifactId>core</artifactId>
155.             <version>3.3.3</version>
156.         </dependency>
157.         
158.         <dependency>
159.             <groupId>cn.hutool</groupId>
160.             <artifactId>hutool-all</artifactId>
161.             <version>5.5.7</version>
162.         </dependency>
164.         
165.         
166.         <dependency>
167.             <groupId>com.alibaba</groupId>
168.             <artifactId>easyexcel</artifactId>
169.             <version>2.2.6</version>
170.         </dependency>
171.         
175.         
176.         <dependency>
177.             <groupId>io.springfox</groupId>
178.             <artifactId>springfox-swagger2</artifactId>
179.             <version>2.9.2</version>
180.         </dependency>
182.         
183.         <dependency>
184.             <groupId>io.springfox</groupId>
185.             <artifactId>springfox-swagger-ui</artifactId>
186.             <version>2.9.2</version>
187.         </dependency>
188.         <dependency>
189.             <groupId>junit</groupId>
190.             <artifactId>junit</artifactId>
191.         </dependency>
201.     </dependencies>
203.     <build>
204.         <plugins>
205.             <plugin>
206.                 <groupId>com.github.shalousun</groupId>
207.                 <artifactId>smart-doc-maven-plugin</artifactId>
208.                 <version>2.4.4</version>
209.                 <configuration>
210.                     
211.                     <configFile>./src/main/resources/smart-doc.json</configFile>
212.                     
213.                     <projectName>ysyn</projectName>
214.                     
215.                     <excludes>
216.                         
217.                         
218.                         <exclude>com.alibaba:fastjson</exclude>
219.                     </excludes>
220.                     
221.                     
222.                     <includes>
223.                         
224.                         <include>com.baomidou:mybatis-plus-extension</include>
225.                         
226.                         <include>com.baomidou:mybatis-plus-core</include>
227.                         
228.                         <include>org.springframework.data:spring-data-commons</include>
229.                     </includes>
230.                 </configuration>
231.                 <executions>
232.                     <execution>
233.                         
234.                         <phase>compile</phase>
235.                         <goals>
236.                            
237.                             <goal>html</goal>
238.                         </goals>
239.                     </execution>
240.                 </executions>
241.             </plugin>
243.             
244.             <plugin>
245.                 <groupId>org.springframework.boot</groupId>
246.                 <artifactId>spring-boot-maven-plugin</artifactId>
247.                
248.                 <configuration>
249.                     <mainClass>com.tring.ysyn.YsynApplication</mainClass>
250.                 </configuration>
251.                 <executions>
252.                     <execution>
253.                         <goals>
254.                             <goal>repackage</goal>
255.                         </goals>
256.                     </execution>
257.                 </executions>
258.             </plugin>
259.         </plugins>
260.     </build>
262. </project>

复制代码

 
2、创建smark doc 配置文件（位置自己再pom文件中定义）注：具体参数可以参考官网：https://smart-doc-group.github.io/#/zh-cn/start/quickstart

1. {
2.   "outPath": "./src/main/resources/md"
3. }

复制代码

 
 
3、打开maven执行（一般选用markdowm）

 4、带个刚刚配置的位置
　　./src/main/resources/md

 

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！