springdoc--spring系统自动生成接口文档（使用）

前提

可运行的springboot项目 IDEA编译器

步骤

1. IDEA导入工具包

工具包：

链接： 提取码：qwer

1. 在根目录下新建名为lib的目录
2. 打开 File -> Project Structure
3. 单击 Libraries -> "+" -> "Java" -> 选择我们导入的项目主目录，点击OK
4. 将刚刚下载的jar包添加进去

5. pom文件添加如下依赖

<dependency>
			<groupId>com.chaoutils.spring-api-doc</groupId>
			<artifactId>sad</artifactId>
			<version>0.0.1-SNAPSHOT</version>
			<scope>system</scope>
			<systemPath>${basedir}/lib/spring-api-doc-1.0-SNAPSHOT.jar</systemPath>
		</dependency>


<!--引入本地资源-->
		<resources>
			<resource>
				<directory>lib</directory>
				<targetPath>BOOT-INF/lib/</targetPath>
				<includes>
					<include>**/*.jar</include>
				</includes>
			</resource>
		</resources>

2. 修改IDEA编译配置

在File | Settings | Build, Execution, Deployment | Compiler | Java Compiler 添加 -parameters

说明：

@RequestMapping(value = "/test10/{id}", method = RequestMethod.GET)
public ResultVO demo10(@PathVariable String id);

我们在入参部分需要获取查询参数名 （id），这使用注解获取是容易的；但是当代码编译后我们是获取不到id的，只能获取到这是一个string类型。然而java8之后提供了新特性，即可以在编译时保留参数名称。按上述配置即可。

3. 添加测试文件

在test目录下新建测试文件

package com.chao.admin;

import com.chaoutils.springapidoc.SpringApiDoc;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.web.context.WebApplicationContext;

@SpringBootTest
public class SpringApiDocTests {

    @Autowired
    WebApplicationContext applicationContext;

    @Test
    void contextLoads() {
        SpringApiDoc springApiDoc = new SpringApiDoc();
        springApiDoc.genarateApiDoc(applicationContext);
    }
}

执行该测试文件，将会在根目录下生成 apidocs/ 文档.md 文件，效果如下