spring boot 集成 Swagger 接口文档详解编程语言

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

swagger: 
  title: API标题 
  description: API描述 
  version: 1.0 
  terms-of-service-url: http://www.javastack.cn/ 
  base-package: cn.javastack.test.web 
  contact: 
    name: Javastack 
    url: http://www.javastack.cn/ 
    email: [email protected]

@Getter 
@Setter 
@Configuration 
@EnableSwagger2 
@ConditionalOnClass(EnableSwagger2.class) 
@ConfigurationProperties(prefix = "swagger") 
public class SwaggerConfig { 
 
    /** 
     * API接口包路径 
     */ 
    private String basePackage; 
 
    /** 
     * API页面标题 
     */ 
    private String title; 
 
    /** 
     * API描述 
     */ 
    private String description; 
 
    /** 
     * 服务条款地址 
     */ 
    private String termsOfServiceUrl; 
 
    /** 
     * 版本号 
     */ 
    private String version; 
 
    /** 
     * 联系人 
     */ 
    private Contact contact; 
 
    @Bean 
    public Docket api() { 
        return new Docket(DocumentationType.SWAGGER_2) 
                .apiInfo(apiInfo()) 
                .select() 
                .apis(RequestHandlerSelectors.basePackage(basePackage)) 
                .paths(PathSelectors.any()) 
                .build(); 
    } 
 
    private ApiInfo apiInfo() { 
        return new ApiInfoBuilder() 
                .title(title) 
                .description(description) 
                .termsOfServiceUrl(termsOfServiceUrl) 
                .version(version) 
                .contact(contact) 
                .build(); 
    } 
 
}

@Api(description = "登录接口") 
@RestController 
public class LoginController { 
 
    @ApiOperation(value = "登录", httpMethod = "POST") 
    @ApiImplicitParams({ 
            @ApiImplicitParam(name = "username", value = "用户名", dataType = "string", paramType = "query"), 
            @ApiImplicitParam(name = "password", value = "密码", dataType = "string", paramType = "query")}) 
    @PostMapping(value = "/login") 
    public Object login(@RequestParam("username") String username, @RequestParam("password") String password) { 
 
        // ... 
 
    } 
}