API Document Generate Spring Boot Project

如何使用

1. 编译安装

mvn clean install

2.添加依赖至WEB项目

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

3. 执行数据库初始化脚本

• 运行db/init.sql创建数据库、创建表

4. WEB项目添加配置

• 在application.properties添加，如下：

api.doc.auto=true
api.doc.project-name=spring-boot-api-doc-db-web
api.doc.web-root-package=top.webdevelop.gull.web
api.doc.datasource.url=jdbc:mysql://127.0.0.1:3306/api_doc?useUnicode=true&characterEncoding=UTF-8&useSSL=true&verifyServerCertificate=false
api.doc.datasource.username=root
api.doc.datasource.password=xxxx
api.doc.datasource.driver-class-name=com.mysql.jdbc.Driver
#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=

4. 发布spring-boot-api-doc-db-web至服务器

• 修改application.yml数据库连接配置