文档 Restful API 创建于 Node.JS
Document Restful API created in Node.JS
我已经在 Node.js 中创建了 Restful 个 API，现在我打算将它们记录下来以便与其他人共享。我花了几天时间研究这个，我发现 Swagger and started exploring what it had to offer. I really like Swagger-UI, It takes a JSON object and generates a document as displayed by this Demo. Another option is using the Swagger-Editor 但这意味着手动写出来，我对此不感兴趣。
所以基本上我觉得如果我可以根据 docstrings/comments 生成 JSON 对象我写在我的 api .js 文件中然后我可以简单地传递 JSON进入 swagger-UI 并获得我漂亮的文档。我一直在寻找可以帮助我实现这一目标的工具。任何工具或教程都会有很大帮助。我查看了 Swagger Open Source Integration Section.
中列出的所有工具
也许我错过了什么，但如果有人能指出正确的方向，我将不胜感激。我对设计优先方法等不感兴趣。我已经有了现有的 API，并想为它们生成文档。我非常感谢有经验的用户的及时回复，因为我真的坚持这一点。我现在没有方向感。
补充说明
我想也许有一个工具甚至可以帮助我创建那个 JSON 对象是个好主意，但我确实觉得我可能错过了一些东西，因为 swagger 如此流行，我相信必须这样做前。
所以我找到了一个非常好的工具，它可以完全满足我的需求。我希望其他人会觉得这个 post 有用。我发现了一个叫做 api-doc swagger 的东西。它利用 api-doc 将文档字符串转换为 json 对象。这个 api-doc swagger 工具更进一步，将 json 对象转换为 swagger json 格式，然后您可以将其传递给 swagger-ui.
我已经在 Node.js 中创建了 Restful 个 API，现在我打算将它们记录下来以便与其他人共享。我花了几天时间研究这个，我发现 Swagger and started exploring what it had to offer. I really like Swagger-UI, It takes a JSON object and generates a document as displayed by this Demo. Another option is using the Swagger-Editor 但这意味着手动写出来，我对此不感兴趣。
所以基本上我觉得如果我可以根据 docstrings/comments 生成 JSON 对象我写在我的 api .js 文件中然后我可以简单地传递 JSON进入 swagger-UI 并获得我漂亮的文档。我一直在寻找可以帮助我实现这一目标的工具。任何工具或教程都会有很大帮助。我查看了 Swagger Open Source Integration Section.
中列出的所有工具也许我错过了什么，但如果有人能指出正确的方向，我将不胜感激。我对设计优先方法等不感兴趣。我已经有了现有的 API，并想为它们生成文档。我非常感谢有经验的用户的及时回复，因为我真的坚持这一点。我现在没有方向感。
补充说明
我想也许有一个工具甚至可以帮助我创建那个 JSON 对象是个好主意，但我确实觉得我可能错过了一些东西，因为 swagger 如此流行，我相信必须这样做前。
所以我找到了一个非常好的工具，它可以完全满足我的需求。我希望其他人会觉得这个 post 有用。我发现了一个叫做 api-doc swagger 的东西。它利用 api-doc 将文档字符串转换为 json 对象。这个 api-doc swagger 工具更进一步，将 json 对象转换为 swagger json 格式，然后您可以将其传递给 swagger-ui.