从 sails + swagger 自动生成中删除一些路线

Question

我有一个 sailsjs API，我想将它与 swagger 集成。我尝试了各种 npm 包，它们可以生成 swagger.json 配置文件。问题是它为所有路由生成 swagger 配置。

在我的routes.js中，我禁用了一些端点

  'GET /user': {response: 'notFound'},
  'POST /user': {response: 'notFound'},
  'PATCH /user': {response: 'notFound'},
  'PUT /user': {response: 'notFound'},
  'DELETE /user': {response: 'notFound'}

这些本质上是禁用的（自动生成的）端点，所以我不希望它们列在我的 API 文档中。

每次运行 API 时都会生成 swagger 文档。我能想到的唯一其他选择是手动管理我的 swagger 文档。

我可以通过在路由定义中添加 swagger 配置块来为 swagger 添加参数，但我还没有找到任何方法通过修改配置来禁用特定端点的 swagger。

Answer 1

尝试

deprecated: true

忽略swagger中的某些路由操作。 Swagger 有各种其他操作来操纵这些路径 - 有关已弃用的操作和其他操作的更多信息，请参见此处。

Answer 2

在所需的路线内插入以下行作为注释：

// #swagger.ignore = true