从 Sails + swagger autogenation 中删除一些路线

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。

Answer 1

尝试deprecated: true 大摇大摆地忽略某些路由操作。 Swagger 有各种其他操作来操纵这些路径 - 有关Deprecated Operations and other operations here 的更多信息。