Problem

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

Solution

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

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

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

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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ファイル を渡せば下記のようなドキュメントが生成されます。

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