読者です 読者をやめる 読者になる 読者になる

API BlueprintについてLTをした

エンジニア飲み会があったので、ちょうど調べていたAPI BlueprintについてLTをした。

スライド↓

API Blueprintとその周辺ツール

API Blueprintは読み書きしやすいのが特徴だ。

JSON SchemaはAPIドキュメントとしてはそのままだと読みにくいし、Swaggerはなんか重厚だし…という人におすすめ。

まあでもSwaggerのyamlは読みやすいよね。 Open API Initiativeで標準フォーマットになったから数あるAPIドキュメントツールの中で数年後生き残るとしたらSwaggerが可能性高いと思う。

JSON Schemaはリクエストやテスト時にデータをチェックしてくれるツールが充実している印象だった。 でもそこまで必要かなー?例えば社内APIだったらそこまで厳密にチェックしなくてもいい気がする。またAPIドキュメントツールに依存し過ぎたくないのでどうにしてもアプリケーション側でデータのチェックすると思うし。テスト時も値の型や構造だけではなく値の内容までチェックするでしょどうにしても。

RAMLはもっと評価されてもよさそうだけどいかんせん後発すぎたのか人気がない…。残念だ。