swagger注解。

曾经终败给现在 2024-02-18 17:33 65阅读 0赞

*  类注解
 *  @Api（类注解）
    
     *  value

> > 表示类的链接地址，访问此类的URL中需要加/，必填。  
> > 
> 
>  *  description

> > 表示类描述信息，选填。  
> > 
> 
>  *  produces

> > 表示返回数据结构，选填。  
> >

*  方法注解
 *  @ApiOperation（方法注释）
    
     *  value

> > 表示访问此方法的链接地址，必填。  
> > 
> 
>  *  notes
> 
> > 表示方法的描述，选填。  
> > 
> 
>  *  httpMethod
> 
> > 表示请求方式，选填。  
> > 
> 
>  *  consumes
> 
> > 表示请求数据结构，选填。  
> > 
> 
>  *  produces
> 
> > 表示响应数据结构，选填。  
> >

*  @ApiImplicitParams（参数注释集）
    
     *  ApiImplicitParam（参数注释）
        
         *  paramType
            
            表示参数位置，可填值有body、head、path、query、form。
         *  name

> > > 表示参数名。  
> > > 
> > 
> >  *  required
> 
> > > 表示是否必填。  
> > > 
> > 
> >  *  value
> 
> > > 表示参数描述。  
> > > 
> > 
> >  *  dataType
> 
> > > 表示参数类型。  
> > >

*  @ApiResponses（响应信息注释集）
    
     *  @ApiResponse（响应信息注释）
        
         *  code
            
            表示响应码。
         *  message

> > > 表示响应码解释。  
> > > 
> > 
> >  *  response
> 
> > > 表示返回类。  
> > >

*  实体类注解
 *  @ApiModel（实体类注解）
    
     *  value
        
        表示对象名称。
     *  description
    
    表示描述。
 *  @ApiModelProperty（实体类字段注释）
    
     *  value

> > 表示字段名。  
> > 
> 
>  *  required

> > 表示是否必填。  
> >

发表评论取消回复

表情：

评论列表（有 0 条评论，65人围观）

还没有评论，来说两句吧...

相关阅读

相关 SWAGGER注解说明

@ApiModelProperty:对象属性,用在出入参数对象的字段上 @Api:用于controller类上 @ApiOperation:用在controller的方法上

旧城等待，/ 2024年03月31日 16:55/ 0 赞/ 107 阅读

相关 swagger注解。

类注解 @Api（类注解） value > > 表示类的链接地址，访问此类的URL中需要加/，必填。 > > > > des

曾经终败给现在/ 2024年02月18日 17:33/ 0 赞/ 66 阅读

相关 Swagger注解

@API详细说明 ![这里写图片描述][70] @ApiImplicitParam ![这里写图片描述][70 1] [70]: /images/202205

傷城~/ 2022年05月22日 07:37/ 0 赞/ 320 阅读

相关 Swagger注解-@ResponseHeader

使用场景作为 @ApiResponse 的属性，作为返回数据的一部分，指定返回 header 信息概述作为返回数据的一部分提供返回数据的 header 信息

た入场券/ 2022年02月14日 06:17/ 0 赞/ 608 阅读

相关 Swagger注解-@ApiOperation

使用场景在 Rest 接口上使用概述描述针对特定路径的操作，通常是 HTTP 方法。具有等效路径的操作被分到单个分组中。HTTP 方法和路径的组合创建了一个

淩亂°似流年/ 2022年02月14日 06:17/ 0 赞/ 945 阅读

相关 Swagger注解-@ApiParam

使用场景在 Rest 接口上或 Rest 接口参数前边使用概述为 Rest 接口参数添加其它元数据(导入到 yapi 中不会被解析) 属性 <tab

骑猪看日落/ 2022年02月14日 06:17/ 0 赞/ 361 阅读

相关 Swagger注解-@SwaggerDefinition

使用场景定义 metadata level 时使用，在 Rest 接口或类上使用概述配置定义 metadata level的注解。仍然缺少 Security

秒速五厘米/ 2022年02月14日 06:15/ 0 赞/ 469 阅读

相关 Swagger注解-@ExternalDocs

使用场景使用外部文档说明的时候使用，参数，方法，属性上可使用概述定义外部文档说明属性 <table> <thead> <tr>

た入场券/ 2022年02月14日 06:13/ 0 赞/ 369 阅读

相关 Swagger注解-@Api

使用场景在 Rest 接口类上边使用。概述标记类为 Swagger 资源类，运行时有效。属性 <table> <thead> <tr>

绝地灬酷狼/ 2022年02月14日 06:13/ 0 赞/ 378 阅读

相关 Swagger注解

swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。 @Api：修饰整个类，描述Controller的作用

短命女/ 2021年10月18日 22:46/ 0 赞/ 531 阅读