OpenAPI・GraphQLツール
API契約まわりの作業はYAMLを書くだけでは終わりません。スキーマの変更が既存のクライアントを壊さないか確認したり、Postmanコレクション変換で仕様書に変換したり、バックエンドが存在する前にリアルなフィクスチャを作ったりします。ここではOpenAPIとGraphQLの編集・差分・モックに加え、curlコマンド生成もまとめています。
リリース前に削除されたフィールドや変更された型、絞り込まれた引数といった破壊的変更を見つけるには、OpenAPI仕様の差分やGraphQLスキーマ差分を使ってください。OpenAPIモックデータ生成はオペレーションからリクエストとレスポンスのJSONを作るので、実際のAPIが完成する前からフロントエンドを動かせます。
7個のツール
OpenAPI / GraphQL / Postmanの全ツール
OpenAPI / GraphQL / Postmanツールに関するFAQ
新旧2つの仕様バージョンをOpenAPI仕様の差分にかけて、追加・削除・変更されたパスやパラメータ、スキーマを並べて確認してください。削除されたフィールド、新たに必須になったパラメータ、狭められた型が、旧仕様に対して動いていたクライアントを壊す変更として最も起きやすいものです。
できます。Postmanコレクション変換はPostmanのコレクションエクスポートを読み込み、検査できるリクエストを含めてOpenAPIドキュメントとして再構築します。完全に自動で無損失な変換というより、OpenAPIフォーマッターでさらに整えていくための出発点として使います。
REST側の差分はOpenAPIドキュメント全体のパス・メソッド・パラメータ・JSONスキーマを比較します。GraphQLスキーマは単一の型付きグラフなので、GraphQLスキーマ差分は代わりに型・フィールド・引数を直接比較し、既存のクエリが実際に解決できるかどうかを判断します。