本次项目我们用Maven来做，最近发现gradle其实很多项目的支持比较差，所以项目还是用Maven来新建项目。对比了市面上的几种API生成第三方库，只有springdoc 是能够按照文档就能部署出来的。
官网：
OpenAPI 3 Library for spring-boot
参考文章：https://zhuanlan.zhihu.com/p/638887405
步骤一：新建项目
步骤二：项目结构以及代码
pom.xml的dependencies添加：
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.6.0</version>
</dependency>HelloController代码如下:
package com.yuye.www.hellospringdoc.controller;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@Tag(name = "公共接口")
@RestController
@RequestMapping("/public")
public class HelloController {
@Operation(summary = "hello")
@GetMapping("/hello")
public String hello() {
return "hello";
}
}
步骤三：访问
http://localhost:8080/swagger-ui/index.html
步骤四：
值得注意是官网说还要在Application里面配置：其实不配置貌似也能启动
# swagger-ui custom path
springdoc.swagger-ui.path=/swagger-ui.html
