标签: iodocs

需要为使用nodejs/express编写的现有应用程序创建api doc

我有一些用普通旧快递写的私人api.是时候把它拿出来并提供一些api文档.

我不想(至少还有)重写我的快速应用程序以将api文档集成到代码中.主要是因为我不确定使用什么框架或规范来记录我的api我真的不想锁定一个特定的东西.

我想在我的api下提供doc作为子资源的一部分(即我不想运行不同的服务器或子域).也许'/ api/docs'.一个加号也可以是我可以嵌入我的应用程序中的UI,可以解析文档,至少在html中提供一个很好的文档演示(api交互是一个加号).

swagger-node这样的东西很酷,但需要我重新编写所有快速代码以集成swagger.在那一点上,我有一笔巨大的投资,并且与swagger紧密相连.

有没有办法服用swagger或iodocs或者其他东西以对现有路线微创的方式记录我的api?

编辑:

我可以用手写的文档提供Swagger规范.我看到的问题是你必须basePath在swagger doc中定义.这实际上不允许我在不同的域下轻松部署.

node.js express api-doc iodocs swagger

8
推荐指数
1
解决办法
9542
查看次数

标签 统计

api-doc ×1

express ×1

iodocs ×1

node.js ×1

swagger ×1