概述
使用springdoc-openapi可以快速为springboot项目生成规范的API文档,具体使用步骤如下:
依赖配置
在pom.xml加入内容,即可开始使用:
dependencygroupIdorg.springdoc/groupIdartifactIdspringdoc-openapi-ui/artifactIdversion1.6.9/version/dependency
然后在Config中配置基本的描述信息,如下:
ConfigurationpublicclassOpenApiConfig{
BeanpublicOpenAPIspringOpenAPI(){returnnewOpenAPI().info(newInfo().title("SpringDocAPITest").description("SpringDocSimpleApplicationTest").version("0.0.1"));}}接下来在Controller中使用注解标记文本,如下:
RestController(value="/clients")
Tag(name="/clients")publicclassClientsRestController{Operation(summary="Thismethodisusedtogettheclients.")GetMappingpublicListStringgetClients(){returnArrays.asList("FirstClient","SecondClient");}}最后Application.java启动应用后,输入默认