记录尚未存在的REST函数

时间:2015-08-25 20:53:16

标签: java json rest pdf

目前,在我的公司,我们有大量的REST功能正在运行,我们将很快创建。我们希望发布那些尚不存在的API调用的文档页面。通过这种方式,即使我们还没有真正的API,UI人员也可以工作。

我知道现有的,Swagger还可以,但是对于那些尚不存在的方法,我们不能创建“空”方法,只是为Swagger发布它们并显示文档。

对于Swagger,我无法为特定请求显示多个REAL有效负载示例。

做了一些研究,我找到了POSTMAN。即使我还没有真正的API,使用POSTMAN我能够记录我需要的每个元素。但是...... POSTMAN还没有“漂亮的打印”功能。

所以我决定从POSTMAN导出一个JSON文件及其关于我的API调用的所有内容,包括样本有效负载请求。之后,我想用Java编写一个程序,接收那个json文件,并在调用我的java程序时根据我的选择给我所需的PDF或HTML格式的输出。 (类似于:java -jar Convert.jar sample.json pdf)

目前,我已成功加载(在我的java程序中)内存中的json文件,它是一个实际复杂的大型POJO对象。

我的问题:我是否应该迭代对象及其子对象(手动)以生成包含其信息的通用HTML文件?或者是否存在一个通用的库或函数,它接收一个大的POJO并以一般(但很好呈现的)HTML(或pdf)格式呈现该对象?

感谢。

0 个答案:

没有答案