您如何记录REST API?

Bes*_*ces 9 rest enunciate

您如何记录REST API?不仅仅是资源是什么的文档,而且实际上是什么是在请求中发送的数据以及在响应中发回的数据.知道某些东西需要发送XML并返回XML是没有用的; 或JASN; 管他呢.如何记录请求中发送的数据以及响应中发回的数据?

到目前为止,我能找到的最好的是Enunciate工具,您可以在其中记录REST API和数据元素.是否为此设置了正确的工具类型,我是否错过任何其他提供此功能的工具,我应该看一下?

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

Bes*_*ces 11

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


Ger*_*sio 5

我有使用Enunciate的经验,这很棒,但我真的不喜欢你可以用它生成的客户端.另一方面,我在上一个项目中一直使用招摇,它似乎符合我的需求,你应该尝试一下真的很酷!

更新03/08/2016:看起来你可以使用Enunciate来构建swagger文档.
看到这个.