APIフォーマット比較
Pros
エコシステム
実装が多くほぼ全てのPlatformで使用可能
実績
Here's one prominent example: Apple's App Store Connect API:
AppleのAppStore Connect APIはJSON:API使ってるとのこと
InstagramのAPIはJSON:APIにインスパイアされている
他使ってるリスト
Pateron
Autodesk
けっこうかっちりしているので人数が多かったり硬めのプロジェクト寄り
ページング
メタ情報
リレーションのinlcude
optionalでのフィールド指定など考慮されている点が多い
Cons
階層が若干深くなる
Pros
フラットに近い
Cons
JSON:APIよりはエコシステムが充実していない
特定のプラットフォーム対応のために自分で
API Blueprint独自のMarkdown記法(MSON)を覚える必要がある
OpenAPIが事実上標準化されているので独自記法はあまり覚えたくない
独自
人員がAPI作成に慣れてる(バージョニング、ページング、メタ情報の考慮、後方互換性等にも気を使える) or プロジェクトに最適化された構造ならあり (ゲーム等)
ただ長期的には人員の入れ替えなどでAPIの統一性を確保するのが難しくバグの温床になる
API作成時と使用時のインピーダンスミスマッチが起こる