Node.js 招摇过市节点表达式用法

Node.js 招摇过市节点表达式用法,node.js,api,express,routes,swagger,Node.js,Api,Express,Routes,Swagger,我想和大家分享一下我对 Github上有564颗星星,因此我认为使用它是合理的,但是: 为什么我应该使用addGet/addPost这样的方法并通过HTTP方法拆分控制器 为什么要将模型包含到路由中 我可以使用验证器进行身份验证,但我必须选择一些应该在那里受到保护的路径。它是重复的,存储在swagger json文件中 使用静态swagger.json并在其上构建快速路由难道不是正确的方法吗? 或者也许我不理解一些实践Swagger只是一个规范。你可以手工制作一个没有任何代码的Swagger

我想和大家分享一下我对

Github上有564颗星星,因此我认为使用它是合理的,但是:

  • 为什么我应该使用addGet/addPost这样的方法并通过HTTP方法拆分控制器
  • 为什么要将模型包含到路由中
  • 我可以使用验证器进行身份验证,但我必须选择一些应该在那里受到保护的路径。它是重复的,存储在swagger json文件中
使用静态swagger.json并在其上构建快速路由难道不是正确的方法吗?
或者也许我不理解一些实践

Swagger只是一个规范。你可以手工制作一个没有任何代码的Swagger规范,将规范提供给一个符合Swagger ui的页面,它“会工作”。你可以有一个完全定义的API,并使用ui页面“运行”它。同样的道理也适用于不招摇的Express——你可以做很多整洁的事情!但是,需要做一些努力才能大摇大摆地记录API

如果要使用swagger node express,则需要将代码耦合到API文档。这可以节省大量时间,并将更改保存在同一个文件中,等等。但是,正如所有问题所暗示的那样,您必须以“招摇过市”节点快速方式进行操作。这两种方法都比单独进行要快,但必须遵循一些约束条件

还有其他一些招摇过市的软件包从不同的角度解决这个问题。我见过一些人试图从Express/Restify路线自动构建招摇过市的文档。swagger node express的另一个替代方案是,它甚至包括验证,但我猜您可能会以某种方式受限于编写没有任何swagger集成的express


您可以自由地手动(或使用一些YAML、jsDoc包或生成器)构建swagger文档,但在编写路由之后,这需要一些额外的时间。另外,它是一个单独的地方来维护您的文档,如果不放弃的话,它们总会在某个时候不同步。使用swagger node express主要是一种节省时间的方法,即使有其缺点,也值得替代方案付出额外的开发努力。

是的,您是对的。可能我的目的不同,因为我已经有了API方法列表,现在我必须为它们编写代码。我只是在寻找最灵活的工具,我同意,在一个已经在运行的应用程序上使用swagger node express需要大量的重写。您可以编写swagger节点express文档
{spec:{},action:importFunction}
,并围绕它们导入当前函数。或者,类似的内容可能更适合您围绕现有API生成招摇过市的文档。