文件名称:apidoc-swagger:apidoc和swagger是两个不错的项目,它们专注于API文档。 这个项目是一个中间层,从某种意义上说,它们试图使用apidoc将内联文档转换为json模式,然后再将其转换为swagger json schmea。
文件大小:90KB
文件格式:ZIP
更新时间:2024-05-22 10:10:11
JavaScript
apidoc-swagger 生成状态: apidoc和swagger是两个不错的项目,它们专注于API文档。 该项目是一个中间层,试图以某种方式将它们组合在一起: 它使用apidoc将内联文档注释转换为json模式,然后将其转换为swagger json模式。 使用库。 这个怎么运作 通过在javascript这样的源代码中添加行注释,您将获得swagger.json文件,该文件可用于以生成文档的html概述。 /api/foo.js : /** * @api { get } /user/id Request User information * @apiName GetUser * @apiGroup User * * @apiParam {Number} id Users unique ID. * * @apiSuccess {String} firstn
【文件预览】:
apidoc-swagger-master
----.gitignore(31B)
----package.json(1KB)
----package-lock.json(212KB)
----bin()
--------apidocSwagger.js(3KB)
----LICENSE(1KB)
----README.md(2KB)
----lib()
--------index.js(3KB)
--------apidocToSwagger.js(8KB)
--------package_info.js(3KB)
----.circleci()
--------config.yml(977B)
----.npmignore(77B)
----test()
--------simple()
----yarn.lock(107KB)