swaggerでAPIドキュメントを書いたらめっちゃはかどった話 - kaz29

Swaggerは、REST APIの仕様とそれに関連するツール群の総称です。REST APIの仕様を定義したJSONファイル(Swagger Spec)を軸に以下のようなツールから構成されています。 Swagger UI - Swagger Spec から動的にAPIドキュメントを生成するツール Swagger Editor - Swagger Specのエディタ Swagger Codegen - Swagger Specからクライアントのコードを生成するツール 最近では、Open API InitiativeがAPIの記述のためにSwaggerを採用して話題になりました。 www.publickey1.jp APIドキュメントのメンテは結構面倒 一般的にAPIの仕様書は、古くはExcel/Wordなどを使ったり、最近ではWikiやMarkdown形式で記述したりなどプロジェクトによって

[kaz_29]

swaggerオススメです。

[koemu]

アプリの人にAPI設計をどう見せるか考えていたところなので参考になった

[akachochin]

Doxygenなどこの手のツールはあるけれど、ソース内のドキュメント部分を更新しないと結局乖離するだろうという懸念がある・・・。ソース内に書くことで、ソースコードレビューで一度に確認はできるが・・・。

[yuya_lush]

さすがだなぁ。これは必読ですよ。

[a-know]

yaml で書けるのがいいよね

[ko-ya-ma]

ソースコード内にコメントとして埋め込んじゃう

[masayoshinym]

”swagger”