OpenAPI サーバー コンポーネント

エンドポイントを有効な OpenAPI 3.x ドキュメントとして公開し、1 つのコンポーネントから配信するネイティブな Delphi コンポーネント — sgcWebSockets HTTP サーバーと統合されています。

TsgcOpenAPIServer

サーバーコンポーネントをフォームに配置するか、コードで生成すれば、OpenAPI ドキュメントを公開し、1 か所からリクエストをルーティングできます。

仕様の公開

サーバーが公開するエンドポイントについて、ライブな openapi.json または openapi.yaml ドキュメントを公開します。クライアントジェネレーターや SwaggerUI、Redoc にそのまま投入できます。

仕様からの構築

OpenAPI ドキュメントに記述されたオペレーションにハンドラーを直接バインドします。ルーティング、パラメーターバインディング、コンテンツネゴシエーションは仕様から導出されます。

sgcWebSockets との統合

sgcWebSockets HTTP サーバーにそのまま組み込めるため、アプリケーションの他の場所で使われているのと同じ TLS、HTTP/2、認証、ロギングのパイプラインを共有できます。

サーバーの詳細

ルーティング

パステンプレート、パスパラメーター、クエリパラメーター、ヘッダー、Cookie は、OpenAPI の paths セクションから自動的に紐付けられます。

検証

受信リクエストと送信レスポンスは、ドキュメントで宣言されたスキーマに対して検証され、ペイロードの不一致については詳細なエラーレポートが提供されます。

セキュリティスキーム

API キー、OAuth2、JWT、HTTP Basic 認証を組み込みでサポート — パーサーが仕様から生成するのと同じセキュリティスキーム定義を再利用します。

コンテンツネゴシエーション

JSON と YAML の自動シリアライズ、マルチパートおよびフォームエンコードされたボディ、オペレーションごとの produces / consumes の処理に対応します。

ドキュメントエンドポイント

同じコンポーネントから配信される、組み込みの SwaggerUI と Redoc UI をオプションで提供 — 同じライブの OpenAPI ドキュメントを参照します。

同じバンドル

パーサー、コードジェネレーター、1,195 以上のビルド済みクラウド SDK と並んで、すべての sgcOpenAPI ライセンス (Single、Team、Site) に含まれます — 個別購入は不要です。

サーバーを試す

無償の体験版をダウンロードして、わずか数分で最初の OpenAPI ドキュメントを公開できます。