从风帆+大张旗鼓的自动生成中删除一些路线

时间:2018-09-20 21:09:31

标签: sails.js swagger

我有一个sailsjs API,我想将它与swagger集成。我尝试了各种npm软件包,这些软件包可以完成生成swagger.json confifg文件的技巧。问题在于它会为所有路由生成摇摇欲坠的配置。

在routes.js中,我已禁用了某些端点

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

swagger

这些实际上是禁用的(自动生成的)端点,因此我不希望它们在我的API文档中列出。

每次我运行API时,都会生成swagger文档。我唯一想到的另一种选择是手动管理我的招摇文档。

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

1 个答案:

答案 0 :(得分:0)

尝试deprecated: true来不理会某些路线操作。 Swagger还有其他各种操作可操纵这些路径-有关Deprecated Operations and other operations here的更多信息。