こんにちは。涼しくなってきましたね。
Protocol Buffers スキーマのドキュメントツールは幾つもありますが、以下を満たすものがなかったので作りました。 pbschema-lens です。できたてほやほやですがお試しいただければ幸い。
- 無償で使える
- カスタムオプションがきれいに表示される
- 導入の手間が少ない
- 大規模スキーマ向けに相互リンクや検索ができる
既存のドキュメンテーションツールやサービスとしては、Buf Schema Registry (BSR) や protoc-gen-doc, Protobuffet などがあります。詳しいことは DMM さんが過去に記事にまとめているのでそちらをお読みください。
その記事にも書いてあるのですが BSR は最も出来が良いものの、非公開の利用においてはタイプ数(≒メッセージ数)に比例した料金体系というのに加え、BSR 上で閲覧者を管理する手間が大きくかかります。 Protobuffet は一瞬使ったのですが、カスタムオプションが表示できないのと、Docusaurus ベースで使い勝手が悪かったです。なお、公開スキーマなら断然 BSR でよいと思います!
続きを読む