写作rest api技术规范的好工具

时间:2015-10-23 13:22:36

标签: web-services api rest documentation specifications

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

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

1 个答案:

答案 0 :(得分:1)

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

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

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

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

希望它能回答你的问题! 亨利