Swagger引入及使用

#引入依赖（官方依赖）

  <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>

第一个是API获取的包，第二是官方给出的一个ui界面。

#配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.test.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger-api")
                .description("XX项目的API文档")
                .termsOfServiceUrl("http://8989")
                .contact(new Contact("xxx", "正在制作个人网站", "xxx@qq.com"))
                .version("1.0")
                .build();
    }
    
}

注意，不用在启动类中添加@ComponentScan(“com.example.mbptest.config”)
#编写规范
##实体类上

@ApiModel(value="物品类", description="请求参数类" )

##实体类的属性上

@ApiModelProperty(value = "名称")

##api上

@Api(tags = "物品相关")

##api方法上

@ApiOperation(value="登陆账号", notes="根据User对象创建用户")

@ApiImplicitParam(name = "jwt", value = "json web token", required = true, dataType = "String")

@ApiImplicitParams({
        @ApiImplicitParam(name = "code", value = "验证码", required = true, dataType = "String"),
        @ApiImplicitParam(name = "key", value = "验证码的key", required = true, dataType = "String"),
        @ApiImplicitParam(name = "account", value = "账号", required = true, dataType = "String"),
        @ApiImplicitParam(name = "password", value = "密码", required = true, dataType = "String"),
        @ApiImplicitParam(name = "request", value = "客户端请求", required = true, dataType = "HttpServletRequest")
})

#ui界面

http://localhost:8989/swagger-ui.html

链接: [https://blog.csdn.net/exlinker/article/details/109926134]