Springboot+Swagger2边写代码边写文档

最新推荐文章于 2024-04-12 13:58:10 发布

Y_R_Q

最新推荐文章于 2024-04-12 13:58:10 发布

阅读量206

点赞数

分类专栏： swagger swagger-ui springboot 文章标签： spring spring boot java

本文链接：https://blog.csdn.net/Y_R_Q/article/details/107631256

版权

本文档介绍了如何在Springboot项目中结合Swagger2快速生成API文档。包括两种方式：Swagger UI和doc.html文档。详细讲解了依赖添加、全局配置、Controller层注解、过滤器设置以及密码保护等步骤。

摘要由CSDN通过智能技术生成

第一种swagger

添加（丝袜哥）依赖maven哈哈哈

<!--Swagger-ui配置-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>

然后创建一个丝袜哥全局配置

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
   
    @Bean
    public Docket createRestApi() {
   
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.regex("^(?!auth).*$"))
                .build()