A certain engineer "COMPLEX"

開発メモ その44 thriftファイルからドキュメントを生成する

Problem


開発メモ その35 protoファイルからドキュメントを生成すると同じように、APIドキュメントを生成できないか、と思って調べてみました。

Solution


なんと、Thrift.exe自体がドキュメントを生成できる模様。
構文は簡単で


thrift.exe --gen html <thriftファイル>

です。
これにより、カレントディレクトリ内部に、gen-htmlフォルダが生成され、

  • index.html
  • style.css
  • <thriftファイル内のサービス>.html

という感じのファイルが出来ます。
index.htmlは、普通に目次ですね。


struct TestStruct {
/** Unique id */
1: string id,
/** Value */
2: i32 value = 10,
}

/** Image manipulation service */
service imageProcService
{
/**
* Invert passed image binary
*/
binary Revert(1:binary image,2:i32 width,3:i32 height, 4:TestStruct test),
}

上記のthriftファイルを渡せば下記のようなドキュメントが生成されます。

コメントや既定値もきちんと反映されます。

コメントを残す

メールアドレスが公開されることはありません。

%d人のブロガーが「いいね」をつけました。