swagger使用详解

springBoot swagger Configuration配置

@Configuration
public class SwaggerConfigure {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.yspay.insurance.online.controller")) //指向你的controller包
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("测试系统")//这个会在Swagger页面中显示,
                .description("服务")
                .termsOfServiceUrl("http://localhost:7000/insurance")
                .version("2.0")
                .build();
    }
}

maven -

<!-- 接口说明文档 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>

 

 

类 级别注解:

@Api

属性:tags-类的说明,description-覆盖类名

@ApiIgnore 隐藏接口,方法,参数

方法级别注解

@ApiImplicitParams({@ApiImplicitParam(name = "<参数名称>", value = "参数说明", required = true, paramType="body")})

paramType 值:
       header-->放在请求头。请求参数的获取:@RequestHeader(代码中接收注解)
       query-->用于get请求的参数拼接。请求参数的获取:@RequestParam(代码中接收注解)
       path(用于restful接口)-->请求参数的获取:@PathVariable(代码中接收注解)
       body-->放在请求体。请求参数的获取:@RequestBody(代码中接收注解)
       form(不常用)
@ApiOperation(value = "创建订单") 方法说明

@ApiParam(value="参数说明",name="参数名",对应方法参数)

实体类注解

第一步,在实体类中@ApiModel(description= “描述”)
第二步,在字段属性中@ApiModelProperty(value = “字段备注”)

 

 

Swagger是一种API文档生成工具,它可以根据代码自动生成API文档,并且可以通过Swagger UI进行查看和测试。Swagger注解是用来描述API信息的一种方式,它可以帮助Swagger生成准确的API文档。 下面是Swagger注解的使用详解: 1. @Api:用于描述API的基本信息,包括API的名称、描述、版本号等。 2. @ApiOperation:用于描述API的操作,包括HTTP请求方法、请求路径、请求参数、返回值等。 3. @ApiParam:用于描述API的参数信息,包括参数名称、参数类型、是否必须、默认值等。 4. @ApiModel:用于描述API的数据模型,包括模型名称、模型属性等。 5. @ApiModelProperty:用于描述API的数据模型属性,包括属性名称、属性类型、是否必须、默认值等。 6. @ApiIgnore:用于忽略API的某些信息,比如某个参数或返回值。 7. @ApiResponses:用于描述API的响应信息,包括响应状态码、响应描述、响应数据类型等。 8. @ApiResponse:用于描述API的单个响应信息,包括响应状态码、响应描述、响应数据类型等。 9. @ApiError:用于描述API的错误信息,包括错误码、错误描述、错误数据类型等。 10. @ApiImplicitParam:用于描述API的隐式参数,比如请求头、请求体等。 11. @ApiImplicitParams:用于描述API的多个隐式参数。 总之,Swagger注解提供了丰富的API描述功能,可以帮助我们更好地生成准确的API文档,提高API的可读性和可维护性。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值