编写 REST API 技术规范的好工具[已关闭]

Question

编写 REST API 技术规范和文档的好工具有哪些？我需要指定 URL、路由、端点。

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

Answer 1

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

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

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

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

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