zoukankan      html  css  js  c++  java
  • Swagger注解说明

    常用注解: 
    @Api()用于类; 
    表示标识这个类是swagger的资源 
    @ApiOperation()用于方法; 
    表示一个http请求的操作 
    @ApiParam()用于方法,参数,字段说明; 
    表示对参数的添加元数据(说明或是否必填等) 
    @ApiModel()用于类 
    表示对类进行说明,用于参数用实体类接收 
    @ApiModelProperty()用于方法,字段 
    表示对model属性的说明或者数据操作更改 
    @ApiIgnore()用于类,方法,方法参数 
    表示这个方法或者类被忽略 
    @ApiImplicitParam() 用于方法 
    表示单独的请求参数 
    @ApiImplicitParams() 用于方法,包含多个 @ApiImplicitParam

    具体使用举例说明: 
    @Api() 
    用于类;表示标识这个类是swagger的资源 
    tags–表示说明 
    value–也是说明,可以使用tags替代 

    @ApiOperation() 用于方法;表示一个http请求的操作 
    value用于方法描述 
    notes用于提示内容 
    tags可以重新分组(视情况而用)

    @ApiParam() 用于方法,参数,字段说明;表示对参数的添加元数据(说明或是否必填等) 
    name–参数名 
    value–参数说明 
    required–是否必填

  • 相关阅读:
    Django-model聚合查询与分组查询
    Django-model基础
    tempalte模板
    Nginx配置TCP请求转发
    使用python调用email模块发送邮件附件
    将txt文本转换为excel格式
    Linux系统
    Aws云服务EMR使用
    SHELL打印两个日期之间的日期
    02-模板字符串
  • 原文地址:https://www.cnblogs.com/chenyanbin/p/13718228.html
Copyright © 2011-2022 走看看