SpringBoot如何嵌入Swagger呢?
下文笔者讲述SpringBoot中Swagger的方法分享,如下所示
Swagger简介
Swagger是一组开源工具
用于设计、构建、文档化和使用RESTful Web服务
它提供了一套规范和工具,帮助开发者创建清晰、易于理解的API文档
可以自动生成类似POSTMAN的效果
SpringBoot中嵌入Swagger的实现思路
在Spring Boot中嵌入Swagger
只需使用以下三个步骤即可实现相应的效果:
1.引入相应的依赖
2.编写Swagger Configuration
3.使用相应的注解
==============================================
步骤一:添加依赖
在pom.xml文件中添加Springfox Swagger的依赖:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version> <!-- 使用最新版本 -->
</dependency>
步骤二:配置Swagger
创建一个配置类,用于配置Swagger的Docket bean:
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.controller")) // 指定扫描的包
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfo(
"Your API Title",
"Your API Description",
"API Version",
"Terms of service",
new Contact("Your Name", "Your URL", "Your Email"),
"License of API",
"API license URL",
Collections.emptylist());
}
}
请确保替换上述代码中的包名、API标题、描述等信息为你实际的项目信息。
步骤三:运行应用并访问Swagger UI
运行你的Spring Boot应用,并访问以下URL以查看Swagger UI:
http://localhost:8080/swagger-ui/index.html
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。


