Swagger注解的使用

已于 2024-05-12 22:31:58 修改
阅读量1.9w 收藏 60
点赞数 11
分类专栏： Java 文章标签： java
于 2022-03-19 16:42:24 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/JokerLJG/article/details/123544934
版权

文章目录

本文内容所使用的的Swagger版本：2.8.0

Swagger注解整理

注解描述
EnableSwagger2用在类上，用于启动Swagger
ApiIgnore用在类、方法、参数上，表示这个类或者方法被忽略（不需要swagger处理）
Api用在类上，对请求类进行描述。标识一个Controller类是Swagger文档类
ApiOperation用在方法上，对请求方法进行描述
ApiImplicitParams在方法上，对请求参数列表进行描述。其中的value属性可包含多个@ApiImplicitParam，对每个参加进行具体的描述
ApiImplicitParam用在方法上，对请求参数进行描述。当需要对多个参数进行描述时，作为@ApiImplicitParams的属性使用
ApiParam用在方法、参数、类的字段上，对请求参数进行描述
ApiModel用在类上，对请求、响应类进行描述
ApiModelProperty用在字段上，对请求、响应类的字段进行描述
ApiResponses用在方法、类上，对响应状态码列表进行描述
Example用在注解类型上，用于描述示例属性列表信息。一般作为@ApiImplicitParam、@ApiParam的属性使用
ExampleProperty用在注解类型上，用于描述示例属性信息。一般作为@Example的属性使用
Extension用在注解类型上，用于描述扩展选项信息。一般作为@ApiOperation、@Info、@Tag的属性使用
ExtensionProperty用在注解类型上，用于描述扩展选项的属性信息。一般作为@Extension的属性使用
SwaggerDefinition定义metadata level时使用，在Rest接口或类上使用
Tag用在注解类型上，用于对单个Apis和ApiOperations的全局标记。一般作为@SwaggerDefinition的属性使用
ExternalDocs用在参数、方法、属性上，使用外部文档说明的时候使用。一般作为@SwaggerDefinition、@Tag的属性使用
Info用在注解类型上，为swagger定义常规元数据。一般作为@SwaggerDefinition的属性使用
Contact用在注解类型上，配置API的可选联系信息。一般作为@Info的属性使用
License用在注解类型上，配置API的可选许可证信息。一般作为@Info的属性使用
Authorization用在方法上，进行接口授权。一般作为@Api或@ApiOperation的属性使用
AuthorizationScope用在方法上，描述接口授权范围。一般作为@Authorization的属性使用
ApiKeyAuthDefinitionOAuth安全定义对象
BasicAuthDefinition基本身份验证安全定义对象
OAuth2DefinitionOAuth安全定义对象
Scope用于指定作用范围，一般作为@OAuth2Definition的属性使用

1. 启动Swagger注解

@EnableSwagger2

用在类上，启动Swagger。

2. 请求类方法描述注解

@ApiIgnore

用在类、方法、参数上，表示这个类或者方法被忽略（不需要swagger处理）。

注解的属性

属性名称属性类型属性默认值属性描述
valueString""简要说明忽略的原因

@Api

用在类上，对请求类进行描述。标识一个Controller类是Swagger文档类。

注解的属性

属性名称属性类型属性默认值属性描述
valueString""描述，无实际意义。
tagsString[]""分组
descriptionString""描述（已弃用）
basePathString""基本路径（已弃用）已无效
positionint0显示顺序（已弃用）已无效
producesStringint输出数据内容类型（已弃用）已无效
consumesStringint输入数据内容类型（已弃用）已无效
protocolsStringint请求协议
authorizationsAuthorization[]@Authorization(value = "")高级特性认证时的配置
hiddenbooleanfalse是否隐藏（不显示）

  1. 注解属性value、tags二者的区别

    1. value属性作用在类和作用在方法上都用于描述；

    2. tags属性作用在类和作用在方法上都用于分组，但分组的效果区别很大：

      1. tags作用在类上时，会对全局的方法分组，即根据tags属性值复制多份，此时方法上的tags值无效，方法上tags配或不配效果都一样。

      2. tags作用在方法上时，会根据当前类的所有方法的tags值做分组，粒度更细。

属性包含的注解

  • @Authorization

使用方法

@RestController
@RequestMapping(value = "swaggerTest")
@Api(tags = "Swagger测试相关接口",description = "Swagger测试相关接口的描述")
public class SwaggerTestController {

}

@ApiOperation

用在方法上，对请求方法进行描述。

注解的属性

属性名称属性类型属性默认值属性描述
valueString描述
notesString""详细描述
tagsString[]""分组
responseClass<?>Void.class响应参数类型
responseContainerString""该属性对这些对象是有效的：List、Set、Map，其他无效。
responseReferenceString""指定对响应类型的引用，本地/远程引用，并将覆盖任何其它指定的response()类
httpMethodString""http请求方式，如：GET、HEAD、POST、PUT、DELETE、OPTION、SPATCH
positionint0显示顺序（已弃用）已无效
nicknameString""第三方工具使用operationId来唯一表示此操作
producesString""输出数据内容类型，如：application/json,application/xml（多个用英文逗号隔开）
consumesString""输入数据内容类型，如：application/json,application/xml（多个用英文逗号隔开）
protocolsString""请求协议
authorizationsAuthorization[]@Authorization(value = "")高级特性认证时的配置
hiddenbooleanfalse是否隐藏（不显示）
responseHeadersResponseHeader[]@ResponseHeader(name = "", response = Void.class)响应头信息，@ResponseHeader数组
codeint200http的状态码
extensionsExtension[]@Extension(properties = @ExtensionProperty(name = "", value = "")扩展属性

属性包含的注解

  • @Authorization
  • @ResponseHeader
  • @Extension

使用方法

    @GetMapping("test1")
    @ApiOperation(value = "test1接口",notes = "test1接口详细描述")
    public ApiResult<String> test1(@RequestParam String aa, @RequestParam String bb, @RequestParam String cc) {
        return ApiUtil.success("success");
    }

3. 请求参数描述注解

@ApiImplicitParams

常用在方法上，对请求参数列表进行描述。
其中的value属性可包含多个@ApiImplicitParam，对每个参加进行具体的描述。

注解的属性

属性名称属性类型属性默认值属性描述
valueApiImplicitParam[]参数列表描述

属性包含的注解

  • @ApiImplicitParam

@ApiImplicitParam

用在方法上，对请求参数进行描述。当需要对多个参数进行描述时，作为@ApiImplicitParams的属性使用。

注解的属性

属性名称属性类型属性默认值属性描述
nameString""参数名
valueString""参数说明
defaultValueString""默认值
allowableValuesString""参数允许值
requiredbooleanfalse是否必填
accessString""参数过滤
allowMultiplebooleanfalse参数是否可以通过多次出现来接受多个值，默认不允许
dataTypeString""参数的数据类型，可以使类名或原始数据类型
dataTypeClassClass<?>Void.class参数的数据类型，如果提供则覆盖 dataType
paramTypeString""参数类型，有效值为 path, query, body, header, form
exampleString""非body类型的参数示例
examplesExample@Example(value = @ExampleProperty(mediaType = “”, value = “”))body类型的参数示例
typeString""添加覆盖检测到的类型的功能
formatString""添加提供自定义format格式的功能
allowEmptyValuebooleanfalse添加将格式设置为空的功能
readOnlybooleanfalse添加被指定为只读的功能
collectionFormatString""添加使用array类型覆盖collectionFormat的功能

属性包含的注解

  • @Example

属性paramType取值

  • header ：通过@RequestHeader获取
  • query：通过@RequestParam获取
  • path：通过@PathVariable获取
  • body：通过@RequestBody获取
  • form：通过@RequestParam获取

使用方法

    @GetMapping("test1")
    @ApiOperation(value = "test1接口",notes = "test1接口详细描述")
    @ApiImplicitParams(value = {
            @ApiImplicitParam(name = "aa",value = "aa的说明",defaultValue = "1",allowableValues = "1,2,3",required = true),
            @ApiImplicitParam(name = "bb",value = "bb的说明",defaultValue = "1",allowableValues = "1,2,3",required = true),
            @ApiImplicitParam(name = "cc",value = "cc的说明",defaultValue = "2",allowableValues = "1,2,3",required = true),

    })
    public ApiResult<String> test1(@RequestParam String aa, @RequestParam String bb, @RequestParam String cc) {
        return ApiUtil.success("success");
    }

@ApiParam

用在方法、参数、类的字段上，对请求参数进行描述。

注解的属性

属性名称属性类型属性默认值属性描述
nameString""参数名
valueString""参数说明
defaultValueString""默认值
allowableValuesString""参数允许值
requiredbooleanfalse是否必填
accessString""参数过滤
allowMultiplebooleanfalse参数是否可以通过多次出现来接受多个值，默认不允许
hiddenbooleanfalse是否隐藏（不显示），默认false
exampleString""非body类型的参数示例
examplesExample@Example(value = @ExampleProperty(mediaType = "", value = ""))body类型的参数示例
typeString""添加覆盖检测到的类型的功能
formatString""添加提供自定义format格式的功能
allowEmptyValuebooleanfalse添加将格式设置为空的功能
readOnlybooleanfalse添加被指定为只读的功能
collectionFormatString""添加使用array类型覆盖collectionFormat的功能

属性包含的注解

  • @Example

使用方法

    @GetMapping("test2")
    @ApiOperation(value = "test2接口",notes = "test2接口详细描述")
    public ApiResult<TestRes> test2(@ApiParam(value = "aa的说明") @RequestParam String aa, @ApiParam(value = "bb的说明") @RequestParam String bb) {
        return ApiUtil.success(new TestRes());
    }

4. 对象描述(请求响应)注解

@ApiModel

用在类上，对请求、响应类进行描述。

注解的属性

属性名称属性类型属性默认值属性描述
valueString""为提供模型的替代名称，默认情况下，使用类名
descriptionString""类的描述
parentClass<?> parentVoid.class为模型提供父类以允许描述继承关系
discriminatoryString""支持模型继承和多态，使用鉴别器的字段的名称，可以断言需要使用哪个子类型
subTypesClass<?>[]{}从此模型继承的子类型数组
referenceString""指定对应类型定义的引用，覆盖指定的任何其他元数据

@ApiModelProperty

常用在字段上，对请求、响应类的字段进行描述。

注解的属性

属性名称属性类型属性默认值属性描述
nameString""覆盖属性的名称
valueString""属性说明
allowableValuesString""参数允许值
accessString""过滤属性
notesString""目前尚未使用
dataTypeString""参数的数据类型，可以使类名或原始数据类型
requiredbooleanfalse是否必填
positionint0显示顺序
hiddenbooleanfalse是否隐藏
exampleString""属性的示例值
readOnlybooleanfalse添加被指定为只读的功能
referenceString""指定对应类型定义的引用，覆盖指定的任何其他元数据
allowEmptyValuebooleanfalse允许传空值

使用方法

@Data
@ApiModel(description = "测试请求类")
public class TestReq {

    @ApiModelProperty(value = "用户ID",required = true)
    private Long userId;
    @ApiModelProperty(value = "用户名",example = "张三")
    private String userName;
    @ApiModelProperty(value = "性别：1男、2女")
    private Integer sex;
    @ApiModelProperty(value = "昵称")
    private String nickName;
    @ApiModelProperty(value = "邮箱")
    private String email;
    @ApiModelProperty(value = "创建时间")
    private Date createTime;
}

@Data
@ApiModel(description = "测试响应类")
public class TestRes {

    @ApiModelProperty(value = "用户ID",required = true)
    private Long userId;
    @ApiModelProperty(value = "用户名")
    private String userName;
    @ApiModelProperty(value = "性别：1男、2女")
    private Integer sex;
    @ApiModelProperty(value = "昵称")
    private String nickName;
    @ApiModelProperty(value = "邮箱")
    private String email;
    @ApiModelProperty(value = "创建时间")
    private Date createTime;
}

5. 响应参数描述注解

@ApiResponses

用在方法、类上，对响应状态码列表进行描述。
注解的属性

属性名称属性类型属性默认值属性描述
valueApiResponse[]响应状态码列表的描述

属性包含的注解

  • @ApiResponse

@ApiResponse

用在方法上，对响应状态码进行描述。一般作为@ApiResponses的属性使用。

注解的属性

属性名称属性类型属性默认值属性描述
codeint响应的HTTP状态码
messageString响应的描述
responseClass<?>Void.class用于描述消息有效负载的可选响应类，对应于响应消息对象的 schema 字段
referenceString""指定对响应类型的引用，指定的应用可以使本地引用，也可以是远程引用，将按原样使用，并将覆盖任何指定的response()类
responseHeadersResponseHeader[]@ResponseHeader(name = "", response = Void.class)可能响应的header列表
responseContainerString""声明响应的容器，有效值为List,Set,Map，任何其他值都将被忽略

属性包含的注解

  • @ResponseHeader

@ResponseHeader

用在方法上，对响应头信息进行描述。一般作为@ApiResponse的属性使用。

注解的属性

属性名称属性类型属性默认值属性描述
nameString""响应头参数名称
descriptionString""响应头参数详细描述
responseClass<?>Void.class响应头数据类型
responseContainerString""声明包装响应的容器，有效值为List或Set，任何其他值都将被覆盖

使用方法

    @GetMapping("test2")
    @ApiOperation(value = "test2接口",notes = "test2接口详细描述")
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "请求成功", responseHeaders = {@ResponseHeader(name = "header1", description = "header1的描述",response = String.class)}),
            @ApiResponse(code = 401, message = "没有权限"),
            @ApiResponse(code = 403, message = "禁止访问")
    })
    public ApiResult<TestRes> test2(@ApiParam(value = "aa的说明") @RequestParam String aa, @ApiParam(value = "bb的说明") @RequestParam String bb) {
        return ApiUtil.success(new TestRes());
    }

6. 示例信息注解

@Example

用在注解类型上，用于描述示例属性列表信息。一般作为@ApiImplicitParam、@ApiParam的属性使用。

注解的属性

属性名称属性类型属性默认值属性描述
valueExampleProperty[]示例的属性信息集合

属性包含的注解

  • @ExampleProperty

@ExampleProperty

用在注解类型上，用于描述示例属性信息。一般作为@Example的属性使用。

注解的属性

属性名称属性类型属性默认值属性描述
mediaTypeString“default”属性名称
valueString属性值

7. 扩展信息注解

@Extension

用在注解类型上，用于描述扩展选项信息。一般作为@ApiOperation、@Info、@Tag的属性使用。

注解的属性

属性名称属性类型属性默认值属性描述
nameString""扩展的选项名称
propertiesExtensionProperty[]扩展选项的属性集合

属性包含的注解

  • @ExtensionProperty

@ExtensionProperty

用在注解类型上，用于描述扩展选项的属性信息。一般作为@Extension的属性使用。

注解的属性

属性名称属性类型属性默认值属性描述
nameString属性名称
valueString属性值

8. Swagger配置相关注解

①、Swagger配置注解

@SwaggerDefinition

定义metadata level时使用，在Rest接口或类上使用。

注解的属性

属性名称属性类型属性默认值属性描述
hostString""要在生成的Swagger定义中指定的主机
basePathString""指定生成的Swagger文档定义basePath
consumesString[]""
producesString[]""
schemesScheme[]Scheme.EFAULTAPI 的传输协议
tagsTag[]@Tag(name = "")可用于对单个Apis和ApiOperations的全局标记
securityDefinitionSecurityDefinition@SecurityDefinition()安全方案的定义
infoInfo@Info(title = "", version = "")为swagger定义常规元数据
externalDocsExternalDocs@ExternalDocs(url = "")外部文档

属性包含的注解

  • @Tag
  • @ExternalDocs
  • @Info
  • @SecurityDefinition

②、标记信息注解

@Tag

用在注解类型上，用于对单个Apis和ApiOperations的全局标记。一般作为@SwaggerDefinition的属性使用。

注解的属性

属性名称属性类型属性默认值属性描述
nameString标记的名称
descriptionString""标记的描述
externalDocsExternalDocs@ExternalDocs(url = "")标记的外部文档参考选项
extensionsExtension[]@Extension(properties = @ExtensionProperty(name = "", value = "")扩展属性集合选项

属性包含的注解

  • @Extension

③、外部文档配置注解

@ExternalDocs

用在参数、方法、属性上，使用外部文档说明的时候使用。一般作为@SwaggerDefinition、@Tag的属性使用。

注解的属性

属性名称属性类型属性默认值属性描述
valueString""目标文档的简要描述，GFM语法可用于富文本表示
urlString引用文档的URL

④、元数据配置注解

@Info

用在注解类型上，为swagger定义常规元数据。一般作为@SwaggerDefinition的属性使用。

注解的属性

属性名称属性类型属性默认值属性描述
titleStringAPI的标题
versionStringAPI的版本
descriptionString""API的描述选项
termsOfServiceString""API的可选服务条款
contactContact@Contact(name = "")API的可选联系信息
licenseLicense@License(name = "")API的可选许可证信息
extensionsExtension[]@Extension(properties = @ExtensionProperty(name = "", value = ""))API的可选扩展列表信息

属性包含的注解

  • @Contact
  • @License
  • @ExternalDocs

⑤、联系人配置注解

@Contact

用在注解类型上，配置API的可选联系信息。一般作为@Info的属性使用。

注解的属性

属性名称属性类型属性默认值属性描述
nameString联系人名称
urlString""联系人关联URL
emailString""联系人邮箱

⑥、许可证配置注解

@License

用在注解类型上，配置API的可选许可证信息。一般作为@Info的属性使用。

注解的属性

属性名称属性类型属性默认值属性描述
nameString许可证名称
urlString""许可证关联URL

⑦、安全方案配置注解

@Authorization

用在方法上，进行接口授权。一般作为@Api或@ApiOperation的属性使用。

注解的属性

属性名称属性类型属性默认值属性描述
valueString要在此资源/操作上使用的授权方案名称。必须在资源列表的授权部分中定义名称
scopesAuthorizationScope[]@AuthorizationScope(scope = "", description = "")授权方案为OAuth2时使用的范围

属性包含的注解

  • @AuthorizationScope

@AuthorizationScope

用在方法上，描述接口授权范围。一般作为@Authorization的属性使用。

注解的属性

属性名称属性类型属性默认值属性描述
scopeString要使用的OAuth2授权方案的范围。范围应事先在Swagger对象的securityDefinition部分中声明
descriptionString在1.5.X中使用，保留用于旧版本的支持

@SecurityDefinition

用在注解类型上，用于安全方案的定义。一般作为@SwaggerDefinition的属性使用。

注解的属性

属性名称属性类型属性默认值属性描述
oAuth2DefinitionsOAuth2Definition[]{}OAuth安全定义对象集合
apiKeyAuthDefintionsApiKeyAuthDefinition[]{}已弃用
apiKeyAuthDefinitionsApiKeyAuthDefinition[]{}API Key安全定义对象集合
basicAuthDefinionsBasicAuthDefinition[]{}已弃用
basicAuthDefinitionsBasicAuthDefinition[]{}基本身份验证安全定义对象集合

@ApiKeyAuthDefinition

OAuth安全定义对象。

注解的属性

属性名称属性类型属性默认值属性描述
keyString用于引用此安全定义的密钥
descriptionString""安全方案的简短描述
inStringApiKeyLocationAPI 密钥的位置，有效值为query或header
nameString要使用的query或header参数的名称

@BasicAuthDefinition

基本身份验证安全定义对象。

注解的属性

属性名称属性类型属性默认值属性描述
keyString用于引用此安全定义的密钥
descriptionString""安全方案的简短描述

@OAuth2Definition

OAuth安全定义对象。

注解的属性

属性名称属性类型属性默认值属性描述
keyString用于引用此安全定义的密钥
descriptionString""安全方案的简短描述
flowFlowOAuth2 安全方案使用的流程。有效值为implicit、password、application、accessCode
authorizationUrlString""用于此流程的授权 URL。隐式和访问代码流需要
tokenUrlString""用于此流程的令牌 URL。密码、应用程序和访问代码流需要
scopesScope[]{}作用范围集合

属性包含的注解

  • @Scope

@Scope

注解的属性

属性名称属性类型属性默认值属性描述
nameString范围名称
descriptionString范围描述

注解使用完整源码

SwaggerTestController

@RestController
@RequestMapping(value = "swaggerTest")
@Api(tags = "Swagger测试相关接口",description = "Swagger测试相关接口的描述")
// @ApiIgnore(value = "不想在Swagger文档上显示")
public class SwaggerTestController {

    @GetMapping("test1")
    @ApiOperation(value = "test1接口",notes = "test1接口详细描述")
    @ApiImplicitParams(value = {
            @ApiImplicitParam(name = "aa",value = "aa的说明",defaultValue = "1",allowableValues = "1,2,3",required = true),
            @ApiImplicitParam(name = "bb",value = "bb的说明",defaultValue = "1",allowableValues = "1,2,3",required = true),
            @ApiImplicitParam(name = "cc",value = "cc的说明",defaultValue = "2",allowableValues = "1,2,3",required = true),
    })
    public ApiResult<String> test1(@RequestParam String aa, @RequestParam String bb, @RequestParam String cc) {
        return ApiUtil.success("success");
    }

    @GetMapping("test2")
    @ApiOperation(value = "test2接口",notes = "test2接口详细描述")
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "请求成功", responseHeaders = {@ResponseHeader(name = "header1", description = "header1的描述",response = String.class)}),
            @ApiResponse(code = 401, message = "没有权限", responseHeaders = {@ResponseHeader(name = "header2", description = "header2的描述",response = String.class)}),
            @ApiResponse(code = 403, message = "禁止访问")
    })
    public ApiResult<TestRes> test2(@ApiParam(value = "aa的说明") @RequestParam String aa, @ApiParam(value = "bb的说明") @RequestParam String bb) {
        return ApiUtil.success(new TestRes());
    }

    @PostMapping("test3")
    @ApiOperation(value = "test3接口",notes = "test3接口详细描述")
    public ApiResult<TestRes> test3(@ApiParam(value = "请求类TestReq") @RequestBody TestReq req) {
        return ApiUtil.success(new TestRes());
    }
}

TestReq

@Data
@ApiModel(description = "测试请求类")
public class TestReq {

    @ApiModelProperty(value = "用户ID",required = true)
    private Long userId;
    @ApiModelProperty(value = "用户名",example = "张三")
    private String userName;
    @ApiModelProperty(value = "性别：1男、2女")
    private Integer sex;
    @ApiModelProperty(value = "昵称")
    private String nickName;
    @ApiModelProperty(value = "邮箱")
    private String email;
    @ApiModelProperty(value = "创建时间")
    private Date createTime;
}

TestRes

@Data
@ApiModel(description = "测试响应类")
public class TestRes {

    @ApiModelProperty(value = "用户ID",required = true)
    private Long userId;
    @ApiModelProperty(value = "用户名")
    private String userName;
    @ApiModelProperty(value = "性别：1男、2女")
    private Integer sex;
    @ApiModelProperty(value = "昵称")
    private String nickName;
    @ApiModelProperty(value = "邮箱")
    private String email;
    @ApiModelProperty(value = "创建时间")
    private Date createTime;
}
骑个小蜗牛
关注
  • 11
    点赞
  • 踩
  • 60
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
专栏目录
Spring Boot配置Swagger增强工具
m0_38075227的博客
01-13 4055
参考knife4j官方网站：1.6 快速开始 | knife4j 一、话不多说，先看效果 1.Swagger页面这样，这里就不多做介绍 2.增强后的首页 3.API列表 4.API请求参数 5.API响应参数 个人觉得增强后看着很清晰，比原来的要好很多。 二、开始配置 1.pom.xml 配置 <dependency> <groupId>io.springfox</groupId> ...
Swagger的配置的常见注解
八月风的博客
11-22 1193
Swagger是最受欢迎的API文档规范之一。它允许您使用json或yaml元数据描述API的属性。它还提供了一个Web UI，它可以将元数据转换为一个很好的HTML文档。本文介绍了Swagger的配置的使用方法
Swagger 3 注解使用指南
热门推荐
吉屋安的博客
06-07 1万+
注解来描述每个API操作的摘要和详细描述，注解的对象，用于描述参数的数据类型。描述：用于描述操作的输入参数。在上述示例中，我们使用了。注解来描述请求体，以及。注解来描述响应结果，注解来描述路径参数，注解来描述响应结果。
swagger 基本用法
最新发布
qq_33240556的博客
05-23 218
Swagger提供了丰富的配置选项，如接口过滤、安全配置、自定义UI等，可以根据项目需求进一步定制。以上就是Swagger的基本使用方法。随着项目的深入，你可能会用到更多高级特性，比如分组文档、安全认证、扩展插件等。
Swagger常用注解的介绍及使用（详细）
qq_67920857的博客
03-04 957
Swagger常用注解介绍及使用（详细）
swagger的使用及踩坑
十一的博客
10-14 4012
swagger的使用有两种方式: https://blog.csdn.net/weixin_37509652/article/details/80094370 按照该博客中的第一种方式使用@EnableSwagger2Doc注解其实是直接使用的swagger默认配置,生成的页面如下, 手动配置首先要去除启动类上@EnableSwagger2Doc注解,否则会报错. 配置有两种方式, 1.配置类 /** * Swagger2API文档的配置 */ @Configuration @Enabl
springboot 集成 Swagger2 配置以及常用注解的说明和使用 （ 超详细）
m0_63180675的博客
06-30 5959
一、注解的使用 和 说明结构化说明如下： @Api：用在请求的类上，表示对类的说明 tags="说明该类的作用，可以在UI界面上看到的注解" （也就是给类取别名） value="该参数没什么意义，在UI界面上也看到，所以不需要配置" @ApiOperation：用在请求的方法上，说明方法的用途、作用 value="说明方法的用途、作用" notes="方法的备注说明" @ApiImplicitParams：用在请求的方法上，表示一组参数说明 @Ap
Swagger 常用注解
yy139926的博客
05-30 2763
通过代码和注释自动生成文档。在 Swagger 框架下，开发人员可对服务进行归类说明，对方法，模型，返回结果等进行详细说明。
@EnableSwagger2注解类的基本配置以及启动接口文档
zouyang920的博客
07-06 5200
地址访问：http://localhost:端口号/swagger-ui.html 参考链接
Swagger2学习记录
蜡笔小新1980的博客
11-30 182
Swagger 是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
4. enable swagger2 for spring boot
JessicaWin
05-12 749
添加swagger2的相关依赖包 实现swagger2配置文件 启用swagger2 参考 https://www.tutorialspoint.com/spring_boot/spring_boot_enabling_swagger2.htm
springboot swagger2注解使用的教程
08-19
Spring Boot Swagger2 注解使用教程 本文主要介绍了 Spring Boot 项目中使用 Swagger2 的注解，详细讲解了每个注解的作用和使用方法，对大家的学习或工作具有一定的参考借鉴价值。 @Api 注解 @Api 注解用在请求的...
Swagger常用注解使用说明
11-22
swagger 用户已api文档自动生成，可以大幅提高客户端和服务端的开发人员的协作效率。本资源主要描述了swagger 注解的使用方法。
springBoog和Swagger2使用的接口注解
01-28
springBoog和Swagger2使用的接口注解，自己整理的注解使用说明
idea生成swagger注解插件,最新版23.2也能用
12-01
根据字段上的doc注释生成swagger注解 @ApiModelProperty(value = "当前登录人名称") 快捷键 ctrl+n \command+n \右键Generate 打开generate页面，选择swagger
swagger简单使用
12-12
此时启动SpringBoot项目，浏览http://localhost:8080/swagger-ui.html，可以发现已经有了项目的API信息。但这些信息是swagger自动配置的，如果需要定制更详细的信息，可以使用注解。
Swagger:Swagger中的常用注解
weixin_47609997的博客
07-27 8117
一、@Api 多作用在Controller类上，用来描述类信息 参数： 1.description：描述这个类的作用。 2.tags：设置这个类的一个标签。 @Api(tags = "招聘管理",description = "用于招聘模块的测试") @Controller public class ResumeController { } 二、@ApiOperation 作用在Controller类的方法上，用来描述接口信息 参数：value可以加以说明 @ApiOperatio
beego集成swagger
jacklife的博客
08-04 3043
背景 最近在做的一个项目为前端提供rest接口，编程语言为go，框架采用的是beego，在beego框架中集成swagger可以很方便的展示已经实现的后端rest接口。 前提 beego框架的安装和使用可以直接参考beego官网，文档也是中文的，可读性很高。 步骤 1 创建beego项目： 通过bee api hello 命令创建hello项目。 2 swagge...
一、swagger常用注解
weixin_40947906的博客
09-03 1037
一、swagger常用注解1、与模型相关的注解两个注解：@ApiModel：用在模型类上，对模型类做注释；@ApiModelProperty：用在属性上，对属性做注释2、与接口相关的注解六个注解：@Api：用在controller上，对controller进行注释；@ApiOperation：用在API方法上，对该API做注释，说明API的作用；@ApiImplicitParams：用来包含API...
swagger 注解的使用
05-01
Swagger是一个用于设计、构建、文档化和测试RESTful Web服务的开源工具集。在Swagger中，我们可以使用注解为API提供详细的描述信息，以便在Swagger UI界面上生成API文档。 下面是几个常用的Swagger注解： 1. @Api 这个注解是一个Controller级别的注解，用于描述整个Controller的信息，包括Controller的名称、描述信息、作者、版本、许可证等。 2. @ApiOperation 这个注解用于描述一个方法的详细信息，包括方法名、方法描述、请求参数、返回值、请求方式等。 3. @ApiParam 这个注解用于描述一个方法的请求参数，包括参数名称、类型、是否必选、默认值等。 4. @ApiModel 这个注解用于描述一个数据模型，包括模型名称、描述信息、字段信息等。 5. @ApiModelProperty 这个注解用于描述数据模型的一个字段，包括字段名称、类型、描述信息、是否必选等。 通过使用Swagger注解，我们可以为API提供详细的描述信息，使得API更易于使用和理解。同时，Swagger也支持生成API文档和测试页面，大大提高了API的开发效率。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值