Swagger

呆萌IT少女

已于 2024-08-21 15:03:47 修改

阅读量153

点赞数 1

CC 4.0 BY-SA版权

文章标签： java 开发语言

于 2022-09-15 16:42:42 首次发布

本文链接：https://blog.youkuaiyun.com/smokeblue/article/details/126874653

引入依赖到pom文件：

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

2.加入配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                // 指定构建api文档的详细信息的方法：apiInfo
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.wonsec.controller"))
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("w-avc API接口文档")
                .description("接口文档描述")
                //这个你可以修改
                .contact(new Contact("xiaoMeng","","343553543X@qq.com"))
                .version("1.0")
                .build();
    }
}

3.关键注解

//这个注解表示本类的方法要生成api文档，注解到要生成API的类上
@Api

4.在每一个接口上添加注解：

常用注解：@Api、@ApiOperation、@ApiImplicitParams/@ApiImplicitParam

//用这个函数做例子吧,这个参数里有对象
@ApiOperation("注册")
//这个注解的value值是ApiImplicitParam数组，所以当有多个参数的时候用这个注解
@ApiImplicitParams(value = {
        //不要用dataTypeClass
        @ApiImplicitParam(name = "user",dataType = "User"),
        @ApiImplicitParam(name = "verify_code",value = "验证码")
})