Springboot使用swagger

简介

首先任何一种框架的技术的出现都有几个基本的特性：安全，便捷，解耦
swagger 为解决接口文档的编写、测试提供了方便，用法简单

用法

• 引包

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

• 配置

/**
 * swagger 访问地址 localhost:port/swagger-ui.html
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {


    @Bean
    public Docket createApi(){

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(getInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.lx.chat.controller"))
                .build();
    }

    private ApiInfo getInfo() {

        return new ApiInfoBuilder()
                .title("标题")
                .description("描述")
                .termsOfServiceUrl("http://localhost:8080")
                .version("v1.0")
                .licenseUrl("https://console.cloud.tencent.com/ssl")
                .contact("asdadssa")
                .build();
    }

}

• 使用
  方法商家说明，不加默认显示方法名

 @ApiOperation("登录方法")
    @PostMapping("/login")
    public ResultBase login(@RequestBody Map<String, String> person){

        ResultBase userList = sysUserService.selectByLoginnameAndPassword(person.get("loginname"),person.get("password"));

        return  userList;

    }

• 访问 访问地址 ip:port/swagger-ui.html