本文へスキップ

OpenAPIとは?

おーぷんえーぴーあい

REST APIをYAML/JSONで記述する業界標準仕様。

SwaggerをLinux Foundationが引き継いだREST API記述の業界標準仕様で、エンドポイント・パラメータ・レスポンスをYAMLまたはJSONで機械可読に定義する。

使い方・例文

OpenAPIのスペックファイルからコードジェネレーターを使うとTypeScriptの型定義やAPIクライアントコードを自動生成でき、フロントとバックエンドの型の乖離を防げる。

この用語をシェア

𝕏 でポスト LINE

最終更新:

関連用語