API Document Generate Spring Boot Project

如何使用

1. 编译安装

mvn clean install

2.添加依赖至WEB项目

<dependency>
    <groupId>top.webdevelop.gull</groupId>
    <artifactId>spring-boot-starter-api-doc</artifactId>
    <version>1.0.RELEASE</version>
</dependency>

3. 添加配置

• 在application.properties添加，如下：

api.doc.auto=true
api.doc.web-root-package=top.webdevelop.gull.web
#api.doc.include-bean-names=
#api.doc.include-method-names=
#api.doc.exclude-bean-names=
#api.doc.exclude-method-names=
#api.doc.output-current-path=
api.doc.output-root-path=/Users/xxx/Downloads/test/doc

4. 发布output静态资源

• 可以建一个Repository、输出接口Metadata至该Repository根目录
• 需要中文的情况下、修改title或desc属性、加上中文
• 提交Metadata文件、持续集成自动部署至web容器或对象存储