Swagger编辑器，如何添加其他“隐藏”信息？

Question

我使用swagger编辑器向公众声明了一些路由端点，但是，我想将路由器功能名称（控制功能）添加到端点路径中作为附加信息，但仅作为对我的信息（私人的）。例如。识别我用于特定路由的中间件功能。可以吗，如果可以，怎么办？

Answer 1

首先，OpenAPI规范提供了operationId关键字，某些工具将其映射到方法名称。

paths:
  /users:
    get:
      operationId: getUsers
      ...
    post:
      operationId: addUser
      ...

您还可以添加带有x-前缀的任意自定义键（所谓的extension properties）。常见的扩展属性是x-swagger-router-controller，用于指定控制器类。

paths:
  /foo:
    x-swagger-router-controller: users