rest - 您如何记录REST API?

标签 rest enunciate

您如何记录REST API?不仅是关于资源是什么的文档,而且实际上是在请求中发送的数据是什么,以及在响应中发回的数据是什么。知道某事希望发送XML并返回XML并没有多大用处;或JASN;管他呢。您如何记录请求中发送的数据和响应中发送回的数据?

到目前为止,我能找到的最好的是Enunciate工具,您可以在其中记录REST API和数据元素。是说出适合此工具的类型,我是否错过了其他应提供的工具?

我的REST API的使用者可以使用任何语言的python,Java,.NET等

最佳答案

我为我的项目决定的方法是Enunciate。似乎是REST API文档的事实上的标准。

关于rest - 您如何记录REST API?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/11939542/

相关文章:

rest - 在哪里为前端/后端应用程序编写测试?

java - 路径参数和表单数据参数

php - 组注释不起作用

rest - 在 Delphi 中哪里将访问 token 附加到 google REST 请求?

java - Bean 同时是 EJB 和 JX-RS 资源

url - REST:发布与发布以及新建与创建

java - java 1.8 上的 maven-enunciate-plugin 作为 apt 现在已从最新的 JDK(即 java 注释处理工具)中删除

java - 阐明为现有 java REST API 创建文档

php - 如何记录基于 Symfony 的 REST API(类似于 enunciate 的文档功能)