端点在招摇中按http方法分组

【问题标题】：endpoints group by http method in swagger端点在招摇中按http方法分组
【发布时间】：2020-11-11 14:54:15
【问题描述】：

我有多个控制器，每个控制器都有 GET、POST、PUT、DELETE api。默认情况下，在控制器级别大摇大摆地分组 API。有没有办法在 swagger doc 中按 http 方法类型对这些 api 进行分组？即一起获取 api，一起发布 api 等。

【问题讨论】：

您使用什么库/框架（例如 Swashbuckle、Springfox、Swagger-PHP、...）？

标签： swagger swagger-ui

【解决方案1】：

您可以在您正在定义的每个 api 路径级别使用“标签”部分。这就是您在 swagger 中标记 API 路径的方式，如下所示。

paths:
  /pet:
    post:
      tags:   // This is where you provide your method type to group all your APIs for a given http method . Same you can do to tag "GET" methods .
      - "POST"
      summary: "Add a new pet to the store"
      description: ""
      operationId: "addPet"

对于所有获取 API，您可以为发布 API 提供标记为“GET”、“POST”等。我为您设置了一个示例，这可能有助于您形象化。

【讨论】：