融资项目——swagger2的注解

1. @ApiModel与@ApiModelProperty(在实体类中使用)

如上图,@ApiModel加在实体类上方,用于整体描述实体类。@ApiModelProperty(value="xxx",example="xxx")放于每个属性上方,用于对属性进行描述。swagger2网页上的效果如下图:

2.@Api、@ApiOperation、@ApiParam(在Controller中使用)

@Api使用方式如上图。其用于描述相应的Controller。效果如下:

@ApiOperation(value="xxx",notes="xxx")使用方式如上图,notes是对于value更详细的说明,其用于描述相关的接口。效果如下:

@ApiParam使用方法如上图,value用于对参数进行描述,example给出测试默认值,required用于指出参数是否为必须接收的参数。其效果如下图所示:

相关推荐

  1. Swagger2

    2023-12-24 08:14:04       50 阅读
  2. Swagger2

    2023-12-24 08:14:04       148 阅读

最近更新

  1. docker php8.1+nginx base 镜像 dockerfile 配置

    2023-12-24 08:14:04       94 阅读
  2. Could not load dynamic library ‘cudart64_100.dll‘

    2023-12-24 08:14:04       100 阅读
  3. 在Django里面运行非项目文件

    2023-12-24 08:14:04       82 阅读
  4. Python语言-面向对象

    2023-12-24 08:14:04       91 阅读

热门阅读

  1. Kafka怎么保证消息发送不丢失

    2023-12-24 08:14:04       45 阅读
  2. 【docker笔记】docker常用命令

    2023-12-24 08:14:04       53 阅读
  3. Python知识(3/20):Python运算符全解

    2023-12-24 08:14:04       61 阅读
  4. mobx-react快速入门使用

    2023-12-24 08:14:04       66 阅读
  5. 详解Keras3.0 KerasNLP Models: GPT2 GPT2Tokenizer

    2023-12-24 08:14:04       49 阅读
  6. MySQL8主主搭建

    2023-12-24 08:14:04       45 阅读