我过去将Swagger用于Java REST API,它是用于此目的的最佳可用工具。
swagger是否支持为Thrift RPC文件生成文档?
答案 0 :(得分:0)
节俭RPC文件
Thrifts基本文档是Thrift IDL或界面描述语言。
此IDL以高层次的方式描述了API,同时用作生成语言绑定所需代码的输入。
为实现这一目标,Thrift IDL文件不仅包含声明,而且还允许在其中使用bot常规注释和所谓的“ doc注释”。许多lanaguge绑定支持将文档注释直接转换为特定于langauge的形式,因此文档也可以在生成的代码中找到自己的方式。
源代码树中有一个good example for documentation inside a Thrift IDL file。另外,考虑使用GraphViz生成器(-gen gv
)获取IDL或HTML生成器(-gen html
)或(较旧的)XSD生成器的图形文档。
Swagger(或Apiary)提供了一种UI类型的交互方式来实现。今天,Thrift中没有类似的东西。
swagger支持生成Thrift [...]文件的文档吗?
Swagger处理RESTful服务。 Thrift是一个RPC系统,两者在概念上有所不同。因此,几乎不可能大张旗鼓地能够记录REST以外的任何内容。
答案 1 :(得分:0)
简短回答否-Swagger不支持节俭。
这是最接近于摇摇欲坠的,幸运的是,它可以节俭地得到支持
此命令为给定的Thrift文件生成HTML文档。
thrift -r --gen html your-thrift.thrift
在对此进行挖掘时,还发现您可以生成旧文件中定义的数据结构的自动图
thrift -r --gen gv your-thrift.thrift
dot -Tpdf -o your-thrift.pdf gen-gv/your-thrift.gv