Java Springboot--swagger配置

╰+攻爆jí腚メ 2022-10-02 12:43 202阅读 0赞

文章转载自：

第一步，配置pom.xml文件：

<dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.7.0</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.7.0</version>
    </dependency>

第二步，添加Swagger2Config.java类：

package com.config;
     
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.bind.annotation.RestController;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.ParameterBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.schema.ModelRef;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.service.Parameter;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
     
    import java.util.ArrayList;
    import java.util.List;
     
    //参考：http://blog.csdn.net/catoop/article/details/50668896
    /**
     * @author xiebq
     *
     */
    @Configuration
    @EnableSwagger2
    public class Swagger2Config {
     
        @Bean
        public Docket createRestApi() {
            List<Parameter> pars = new ArrayList<Parameter>();
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                    .paths(PathSelectors.any())
                    .build()
                    .globalOperationParameters(pars)
                    .apiInfo(apiInfo());
        }
     
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("拾花酿春 RESTful API")
                    .description("展示先做基础功能，后面再添加业务")
                    .termsOfServiceUrl("https://www.cnblogs.com/xiebq/")
                    .version("1.0")
                    .build();
        }
     
    }

我们也可以在swagger上设置请求参数，可以加入token等，这样代码就是：

@Configuration
    @EnableSwagger2
    public class Swagger2Config {
     
        @Bean
        public Docket createRestApi() {
            List<Parameter> pars = new ArrayList<Parameter>();
    
            ParameterBuilder ticketPar = new ParameterBuilder();
            ticketPar.name("token").description("token")
        	.modelRef(new ModelRef("string")).parameterType("header")
        	.required(false).build();
            pars.add(ticketPar.build());
    
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                    .paths(PathSelectors.any())
                    .build()
                    .globalOperationParameters(pars)
                    .apiInfo(apiInfo());
        }
     
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("拾花酿春 RESTful API")
                    .description("展示先做基础功能，后面再添加业务")
                    .termsOfServiceUrl("https://www.cnblogs.com/xiebq/")
                    .version("1.0")
                    .build();
        }
     
    }

打开网页：http://localhost:端口号/swagger-ui.html\#!

我这里是：http://localhost:8600/swagger-ui.html\#!

![1306642-20180616164340626-1116426247.png][]

第三步，自定义配置：

请求中添加注释

![1306642-20180616164539944-673893316.png][]

在传入的对象中添加注释

![1306642-20180616164547788-790495412.png][]

![1306642-20180616164553137-166936947.png][]

点开请求，就能看请求的具体情况，也可进行 Try it out! 测试

![1306642-20180616165012872-543923958.png][]

添加swagger文档，适合点后端分离，开发人员应熟悉response code 各个代表什么

1xx（临时响应）

2xx （成功）

3xx （重定向）

4xx（请求错误）

5xx（服务器错误）

还有就是项目中自定义的返回码等

[1306642-20180616164340626-1116426247.png]: /images/20220112/39cdebf13b1044bdb84ebecdd643c155.png
[1306642-20180616164539944-673893316.png]: /images/20220112/75f90d0124e5449b975623c840bbc612.png
[1306642-20180616164547788-790495412.png]: /images/20220112/35a667ff2d2047389c00f5b9291c85dd.png
[1306642-20180616164553137-166936947.png]: /images/20220112/a30208669c9646f4adc934be4b9f431c.png
[1306642-20180616165012872-543923958.png]: /images/20220112/f5c422f5b95e48f5b6fcf46fa9c6901e.png