我过去使用Swagger用于Java REST API,它是用于此目的的最佳可用工具 .
swagger是否支持为Thrift RPC文件生成文档?
Thrift RPC文件
Thrifts基本文档是Thrift IDL,或 interface description language .
此IDL以高级方式描述API,同时用作生成语言绑定所需代码的输入 .
最重要的是,Thrift IDL文件不仅包含声明,还允许使用机器人正常注释和所谓的“doc注释” . 许多lanaguge绑定支持从doc-comments直接转换为langauge特定形式,因此文档也将在生成的代码中找到方法 .
源树中有一个good example for documentation inside a Thrift IDL file .
Swagger(或Apiary)提供了一种UI类型的交互式方式来实现 . 这就是今天Thrift中没有等价物的东西 .
Swagger是否支持为Thrift文件生成文档?
Swagger处理RESTful服务 . Thrift是一个RPC系统,两者有一些概念上的差异 . 因此,swagger不太可能达到能够记录REST之外的任何东西的程度 .
相关问题:Can Swagger be used for SOAP?
1 回答
Thrifts基本文档是Thrift IDL,或 interface description language .
此IDL以高级方式描述API,同时用作生成语言绑定所需代码的输入 .
最重要的是,Thrift IDL文件不仅包含声明,还允许使用机器人正常注释和所谓的“doc注释” . 许多lanaguge绑定支持从doc-comments直接转换为langauge特定形式,因此文档也将在生成的代码中找到方法 .
源树中有一个good example for documentation inside a Thrift IDL file .
Swagger(或Apiary)提供了一种UI类型的交互式方式来实现 . 这就是今天Thrift中没有等价物的东西 .
Swagger处理RESTful服务 . Thrift是一个RPC系统,两者有一些概念上的差异 . 因此,swagger不太可能达到能够记录REST之外的任何东西的程度 .
相关问题:Can Swagger be used for SOAP?