SpringBoot3.0.0集成SpringDoc
(1)、导入依赖(注意依赖包最后是ui
结尾)
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.0.4</version>
</dependency>
(2)、编写配置类SpringDocConfig
import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class SpringDocConfig{
@Bean
public OpenAPI springShopOpenAPI() {
return new OpenAPI()
.info(new Info().title("xxxAPI")
.description("xxx Restfull API")
.version("v0.0.1")
.license(new License().name("xxx")))
.externalDocs(new ExternalDocumentation()
.description("xxx Issues Documentation")
.url("https://****"));
}
}
(3)、启动项目输入http://IP地址:端口号/swagger-ui/index.html
例如http://localhost:8081/swagger-ui/index.html
如果你打开网页之后显示一堆JSON格式的数据,那可能是你导入依赖的时候错了
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
<version>2.0.2</version>
</dependency>
这个依赖输入路径之后返回的是JSON数据,依赖名最后是ui
结尾而不是api