OpenAPI 3.x とは?
OpenAPI は、RESTful API を記述するための業界標準仕様です。かつて Swagger と呼ばれており、コード生成、ドキュメント、テストの自動化を可能にします。
OpenAPI は、RESTful API を記述するための業界標準仕様です。かつて Swagger と呼ばれており、コード生成、ドキュメント、テストの自動化を可能にします。
OpenAPI は HTTP API を記述するための機械可読な形式を提供し、ツールがコード、ドキュメント、テストスイートを自動生成できるようにします。
Swagger 1.x と 2.x は、API 記述形式の基礎を築きました。仕様は 2015 年に OpenAPI Initiative に寄贈され、OpenAPI 3.x へと進化しました。
現在の標準は、JSON と YAML 形式、高度なスキーマ定義、複数の認証スキーム、Webhook、オペレーション間のリンクをサポートします。
sgcOpenAPI は任意の OpenAPI または Swagger 仕様をパースし、ネイティブな Object Pascal コードを生成します。Delphi 開発者に第一級の API ツールを提供します。
パス、HTTP メソッド (GET、POST、PUT、DELETE)、クエリパラメーター、ヘッダー、リクエストボディはすべて構造化された形式で定義されます。
データ型、オブジェクトプロパティ、配列、列挙型、合成 (allOf、oneOf、anyOf) により、リクエストとレスポンスのペイロード構造を記述します。
API キー、OAuth 2.0 フロー、HTTP Bearer トークン、OpenID Connect は、オペレーションに適用される再利用可能なセキュリティスキームとして定義されます。