Spring Boot 2 整合Swagger简单入门

Posted 2021-01-28 gdjlc

Swagger是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。

1、pom.xml添加配置

可以到http://mvnrepository.com上搜索springfox，便可以看到Springfox Swagger2和Springfox 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>

2、swagger的configuration

package com.example.demo;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import io.swagger.annotations.ApiOperation;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //.apis(RequestHandlerSelectors.basePackage("com.example.demo.web"))//包所在位置
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any()).build().useDefaultResponseMessages(false);
    }

    /**
     * 获取swagger ApiInfo
     *
     * @return
     */
    private static ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API文档")
                .description("Swagger API 文档")
                .termsOfServiceUrl("http://www.cnblogs.com/gdjlc")
                .version("1.0")
                .contact(new Contact("name..", "url..", "email.."))
                .build();
    }
}

3、Controller中测试方法

package com.example.demo.web;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;

@RestController
@Api(value = "UserController", tags = "用户操作相关接口")
public class UserController {
                
    @ResponseBody    
    @GetMapping("/helloWorld")
    @ApiOperation(value="测试value", notes = "测试notes")
    @ApiImplicitParam(paramType="query", name = "userName", value = "用户编号", required = true, dataType = 

"String")
    public String helloWorld(@RequestParam String userName){
        return "hello world," + userName;
    }
}

Swagger使用的注解及其说明：
@Api：用在类上，说明该类的作用。
@ApiOperation：注解来给API增加方法说明。
@ApiImplicitParams : 用在方法上包含一组参数说明。
@ApiImplicitParam：用来注解来给方法入参增加说明。
@ApiResponses：用于表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
@ApiModel：描述一个Model的信息

 

访问：项目地址/swagger-ui.html，如我的http://localhost:9001/swagger-ui.html
结果如下，可以点击方法右边的【Try it out】按钮开始测试，之后输入参数，点击【Execute】执行查看结果。