swagger

•   swagger.yml API:
  • swagger:版本  eg:"2.0"
  • info:对这个项目的说明
    • description:"说明"
    • version:
    • title:
    • contact:
      • name:
      • email:
      • url:
  • host:ip或域名 eg:"127.0.0.1:8080" 用来拼接请求
  • basePath:用于拼接请求
  • tags:  --标签（分组） 这里建立分组后可以在下面的paths中进行使用
    • name:
    • description:
  • paths:  -- 具体的接口
    • 接口地址:
      • 请求方式
        • tags: --使用在上面已经建立的分组 类型是array
        • summary:
        • description:
        • operationId:
        • consumes:这里设置入参的数据格式列表，默认为第一个
        • produces:这里设置返回的数据格式列表，模式为第一个
        • parameters: -- 这是设置入参格式如下
          • -in: 可选 body query path等
          • name: 参数key值
          • required:是否必须
          • description:
          • schema: --这里可以编辑数据模型 也可以直接引用definitions中定义的模型 可以设置默认值
        • responses:--响应信息设置 2.0和3.0不同 3.0添加了content
          • code:responses状态码
            • description:
• 其中responses可以设置模型进行检验，暂停没学会，后续再补
• swagger与springboot整合
  • 引入和配置参考 https://www.cnblogs.com/jtlgb/p/8532433.html

其中几个注解@Api用于类上，可以用来建立分组，方法上只需使用@ApiOpertion("")即可，

@ApiImplicitParam和@ApiImplicitParams,只有特殊情况下需要使用;正常接口也不需要使用@ApiResponse

使用*Mapping时需要注明produces,否则生成的文档入参将会默认是*/*