目 录CONTENT

文章目录

Swagger2简单配置

Gz
Gz
2023-11-28 / 0 评论 / 0 点赞 / 107 阅读 / 697 字 / 正在检测是否收录...

Swagger2简单配置

1.这里用的gradle管理项目,先导入依赖

  compile "io.springfox:springfox-swagger2:2.9.2"
  compile "io.springfox:springfox-swagger-ui:2.9.2"

2.下面是配置类信息(前两个是分组方法,后面一个是作者信息)

@Configuration
@EnableSwagger2
public class Swagger2Configuration {
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(true)
                .groupName("api-front所有接口")
                .select()
                .apis(RequestHandlerSelectors.basePackage("zy.latte.api.front.web.controller"))
                .build();
    }
    @Bean
    public Docket docket2() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(true)
                .groupName("文章接口")
                .select()
                .apis(RequestHandlerSelectors.basePackage("zy.latte.api.front.web.controller.content"))
                .build();
    }

    private ApiInfo apiInfo() {
        /*作者信息*/
        Contact contact = new Contact("郭争", "https://zinzin.cc", "86736734@qq.com");
        return new ApiInfoBuilder()
                .title("Swagger 测试接口文档")
                .description("Spring Boot 集成 Swagger 测试接口文档")
                .version("v1.0")
                .contact(contact)
                .license("Apache 2.0")
                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0")
                .build();
    }
}

然后重启项目后就可以访问localhost:swagger-ui.html

swagger-ui页面

3.下面就是给类方法上面加注解给swagger自动生成展示

@Api:用在请求的类上,表示对类的说明
    tags="说明该类的作用,可以在UI界面上看到的注解"
    value="该参数没什么意义,在UI界面上也看到,所以不需要配置"

@ApiOperation:用在请求的方法上,说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"

@ApiImplicitParams:用在请求的方法上,表示一组参数说明
    @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
        name:参数名
        value:参数的汉字说明、解释
        required:参数是否必须传
        paramType:参数放在哪个地方
            · header --> 请求参数的获取:@RequestHeader
            · query --> 请求参数的获取:@RequestParam
            · path(用于restful接口)--> 请求参数的获取:@PathVariable
            · body(不常用)
            · form(不常用)    
        dataType:参数类型,默认String,其它值dataType="Integer"       
        defaultValue:参数的默认值

@ApiResponses:用在请求的方法上,表示一组响应
    @ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
        code:数字,例如400
        message:信息,例如"请求参数没填好"
        response:抛出异常的类

@ApiModel:用于响应类上,表示一个返回响应数据的信息
            (这种一般用在post创建的时候,使用@RequestBody这样的场景,
            请求参数无法使用@ApiImplicitParam注解进行描述的时候)
    @ApiModelProperty:用在属性上,描述响应类的属性

4.类方法上

image-1701154787028

5.请求方法上

image-1701662408899

6.在访问localhost:swagger-ui.html

image-1701155345693

0

评论区