我使用Java Jersey(和JAXB)编写了一个非常广泛的REST API.我还使用Wiki编写了文档,但它是一个完全手动的过程,非常容易出错,特别是当我们需要进行修改时,人们往往忘记更新wiki.
从四处查看,大多数其他REST API也可以手动创建文档.但我想知道这是否可能是一个很好的解决方案.
需要为每个端点记录的事物类型是:
然后当然有一些全球性的事情,如
这些一般的东西可以描述一次并且不需要自动化,但对于Web服务方法本身来说,似乎非常希望自动化它.
我想过可能会使用注释,编写一个生成XML的小程序,然后是一个XSLT,它应该用HTML生成实际的文档.使用自定义XDoclet更有意义吗？
我需要实现一个Java REST Web服务(我们使用Jersey框架),它基本上都可以
一个.在返回响应之前阻止等待某个事件(或事件的轮询).提供某种aysnc行为以在处理请求时通知客户端.
我正在考虑返回一个transationID,并且有一个/ status端点,客户端应该轮询该端点以确定是否处理了请求并获得特定结果.
有任何想法吗？