SpringBoot中如何集成Swagger文档

avatar
作者
筋斗云
阅读量:0

要在Spring Boot项目中集成Swagger文档,可以按照以下步骤操作:

  1. 添加Swagger依赖: 在项目的pom.xml文件中添加Swagger的依赖:
<dependency>     <groupId>io.springfoxgroupId>     <artifactId>springfox-boot-starterartifactId>     <version>3.0.0version> dependency> 
  1. 创建Swagger配置类: 在项目中创建一个Swagger配置类,用于配置Swagger的相关信息,例如文档标题、描述、版本等。示例代码如下:
@Configuration public class SwaggerConfig {     @Bean     public Docket api() {         return new Docket(DocumentationType.OAS_30)                 .select()                 .apis(RequestHandlerSelectors.basePackage("com.example.controller"))                 .paths(PathSelectors.any())                 .build()                 .apiInfo(apiInfo());     }      private ApiInfo apiInfo() {         return new ApiInfoBuilder()                 .title("API Documentation")                 .description("Swagger documentation for API endpoints")                 .version("1.0")                 .build();     } } 
  1. 启用Swagger: 在Spring Boot的启动类上使用@EnableSwagger2注解来启用Swagger:
@SpringBootApplication @EnableSwagger2 public class Application {     public static void main(String[] args) {         SpringApplication.run(Application.class, args);     } } 
  1. 访问Swagger文档: 启动Spring Boot应用程序后,可以通过访问http://localhost:8080/swagger-ui/来查看生成的Swagger文档界面,其中包含了API的各个接口和相关信息。

通过以上步骤,就可以在Spring Boot项目中集成Swagger文档并查看API接口的详细信息。

    广告一刻

    为您即时展示最新活动产品广告消息,让您随时掌握产品活动新动态!