写restapi技术规范的好工具

Good tools for writing rest api technical especification

编写 rest api 技术规范和文档的好工具是什么?我需要指定 url、路由、端点。

另一种方法是自动生成 API 文档对其代码进行逆向工程。这是一个 C# 网络服务。

我看到三种主要语言可以做到这一点。然后,您可以使用围绕这些语言的其他工具从中生成文档。

  • Swagger 是一种非常流行和活跃的 Web API 语言,基于 JSON 格式。
  • RAML 基于 YAML 格式。
  • API Blueprint 基于 Markdown。这使得它非常容易阅读。

另一个名为 Slate 的工具是面向文档的。它允许使用不同编程语言的示例调用生成漂亮的文档。

您可以注意到工具 Restlet Studio 允许您在线定义 RESTful 服务的结构,然后获得相应的 Swagger 或 RAML 结构。您甚至可以根据这些格式生成文档(或客户端工具包、服务器框架)。

希望它能回答您的问题! 蒂埃里