当前位置: 首页 > 知识库问答 >
问题:

在swagger中用http方法分组endpoint

孟思远
2023-03-14

我有多个控制器,每个都有GET,POST,PUT,DELETE API。默认情况下,在控制器级别对API进行大摇大摆的分组。在swagger文档中,有没有什么方法可以按http方法类型对这些API进行分组?即一起获取API,一起发布API等。

共有1个答案

谯嘉懿
2023-03-14

您可以在定义的每个api路径级别上使用“tags”部分。这就是您如何在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"

对于所有的get API,您可以提供标记为“get”,对于post API,可以提供“post”等等。我为你建立了一个例子,它可能会帮助你形象化。

 类似资料:
  • 我正在做一个我命名为“主项目”的项目。我至少有10个不同的小项目在那里,这个项目可能会增长。我对所有这些项目只有一个自信,因为所有这些项目都只使用一个dotnet核心web应用程序来进行推广。 例如,假设我有一个名为的项目和一个名为的项目。有三个不同的endpoint,分别名为、、、和。这两个不同的项目将出现在一个大摇大摆的UI中,如下所示: 我想做的是在一个dotnet核心web项目中设置多个不

  • 我使用drf-yasg为我的Django REST API生成swagger文档。我有几个endpoint,项目/与GET,POST和DELETE方法;和项目/ 这是我在 urls.py 中的内容的一个片段: 意见。py包含如下内容: 如何从项目中排除GET和POST/ 我已经通读了https://github . com/ax nsan 12/drf-yasg/blob/master/docs/

  • 本文向大家介绍Javascript数组中push方法用法分析,包括了Javascript数组中push方法用法分析的使用技巧和注意事项,需要的朋友参考一下 本文实例讲述了Javascript数组中push方法用法。分享给大家供大家参考,具体如下: 看下面代码: Q:o现在内部的值是什么样子? 我的第一反应是排斥,为什么要研究不合理情况下【解释引擎】的行为?但是这种推论有时候又很吸引人,于是我回来的

  • 本文向大家介绍spring-boot 禁用swagger的方法,包括了spring-boot 禁用swagger的方法的使用技巧和注意事项,需要的朋友参考一下 在使用spring-boot开发的时候,我们很多时候会使用swagger作为api文档输出。可以在UI界面上看到api的路径,参数等等。 当然,作为开发环境是很方便的,但是上生产环境的时候,我们需要把swagger禁掉。怎么通过配置文件的方

  • HTTP方法在请求中提供,并指定客户端请求的操作。 下表总结了常用的HTTP方法。 Sr.No. 方法和描述 1 GET GET方法请求指定资源的表示。 使用GET的请求应该只检索数据,不应该有其他影响。 2 POST POST方法请求服务器接受请求中包含的数据,作为URI标识的资源的新对象/实体。 3 PUT PUT方法请求服务器接受请求中包含的数据,作为对URI标识的现有对象的修改。 如果它不

  • HTTP方法在请求中提供,并指定客户端请求的操作。 下表列出了最常用的HTTP方法 - S.No. 方法和描述 1 GET GET方法请求指定资源的表示。 使用GET的请求应该只检索数据,不应该有其他影响。 2 POST POST方法请求服务器接受请求中包含的数据,作为URI标识的资源的新对象/实体。 3 PUT PUT方法请求服务器接受请求中包含的数据,作为对URI标识的现有对象的修改。 如果它