3 つのコンポーネントが、2 つの役割をカバーします。TsgcHTTPRESTServer は、CORS、任意で有効化できる /metrics と /health のエンドポイント、そしてマルチテナントのリクエスト解決を組み込んだ REST サーバーです。TsgcWSAPIServer_OpenAPI は LoadFromFile で OpenAPI 3.x のコントラクトを読み込み、すべてのリクエストをそれに照らしてディスパッチ、検証、認証します。TsgcOpenAPI_Client は、OpenAPI で記述された任意の API 向けの型付きクライアントの土台となる基底クラスです。単体で完結しており、sgcWebSockets Core ランタイムが含まれています。
sgcREST は単体のパッケージです。土台となる sgcWebSockets Core ランタイムを同梱し、すべてのライセンスに完全なソースコードが付属するため、REST のディスパッチと OpenAPI の検証をそのままご自身のデバッガーでステップ実行できます。
TsgcHTTPRESTServer は SGC REST ページに、TsgcWSAPIServer_OpenAPI は SGC OpenAPI ページにあります。
/metrics と /health です。任意で有効化でき、サーバーがすでに適用している Authentication の背後で提供されます。
3 つのクラスは方向によって明確に分かれます。REST サーバーと OpenAPI サーバーは、呼び出し元が到達するエンドポイントを公開します。OpenAPI クライアントの基底クラスは、生成された SDK が他者のエンドポイントを呼び出す際に使うものです。
TsgcHTTPRESTServer は sgcWebSockets の HTTP サーバーを拡張し、REST API が日常的に必要とする機能を備えます。クロスオリジンリクエスト向けの CORSOptions、ServerStats を通じて任意で有効化できる /metrics と /health のエンドポイント、そしてホスト、パス、ヘッダー、または JWT クレームによるマルチテナントのリクエスト解決を行う Tenancy です。Tenant が、解決された値を自分のリクエストハンドラーに公開します。
TsgcWSAPIServer_OpenAPI は LoadFromFile または LoadFromString で OpenAPI 3.x のドキュメントを読み込み、動作するディスパッチャーへと変換します。受信するすべてのリクエストは契約と照合され、オペレーション ID によって自分の OnRequest ハンドラーへルーティングされます。OnValidationError、OnAuthenticate、OnValidateAPIKey、OnValidateBasic、OnValidateBearer が、仕様が宣言するセキュリティスキームをカバーし、OnBeforeRequest/OnAfterRequest が呼び出しの前後を挟みます。
TsgcOpenAPI_Client は、OpenAPI で記述された任意の API 向けの汎用ランタイムクライアントです。Authentication が Basic 認証、ベアラートークン、汎用 OAuth2、JWT をカバーし、HTTP_REQUEST と HTTP_REQUEST_Async が呼び出しを実行します。自分で読み込んだ、または生成した契約に SetBaseURL を指定すれば、すぐに呼び出せます。
OnException が、ハンドラーのエラーをワイヤーに届く前に捕捉し、検証と認証の各イベントはすべて、PathParams、QueryParams、RespondJSON を備えた解析済みの TsgcOpenAPIServerContext を受け取ります。呼び出しが受け入れられた理由も拒否された理由も、何一つ隠されません。
REST サーバーと OpenAPI サーバーはどちらも TsgcHTTPServer のサブクラスで、OpenAPI クライアントは Core ランタイムの他の部分と同じ HTTPS スタックの上で動作します。Delphi 7 から RAD Studio 13 まで、そして C++ Builder でも。
各コンポーネントのリファレンスページ:
REST サーバーはリクエストをそのまま渡します。OpenAPI サーバーは、検証済みですでにマッチしたオペレーションを渡します。どちらも Delphi 7 から 13、そして C++ Builder で同じようにコンパイルできます。
uses
sgcHTTP_REST_Server, sgcHTTP_REST_Server_Stats;
var
RESTServer: TsgcHTTPRESTServer;
Stats: TsgcHTTPServerStats;
begin
// REST server: CORS, health/metrics and tenancy in one component
RESTServer := TsgcHTTPRESTServer.Create(nil);
Stats := TsgcHTTPServerStats.Create(nil);
Stats.Endpoints.Health.Enabled := True;
RESTServer.Port := 8080;
RESTServer.CORSOptions.Enabled := True;
RESTServer.CORSOptions.AllowOrigins := 'https://app.example.com';
RESTServer.ServerStats := Stats;
RESTServer.OnCommandGet := RESTServerCommandGet;
RESTServer.Active := True;
end;
procedure TForm1.RESTServerCommandGet(AContext: TIdContext;
ARequestInfo: TIdHTTPRequestInfo; AResponseInfo: TIdHTTPResponseInfo);
begin
AResponseInfo.ContentText := '{"status":"ok"}';
end;uses
sgcWebSocket_Server_API_OpenAPI, sgcHTTP_Server;
var
OpenAPIServer: TsgcWSAPIServer_OpenAPI;
begin
// OpenAPI server: load the contract, dispatch by operation id
OpenAPIServer := TsgcWSAPIServer_OpenAPI.Create(nil);
OpenAPIServer.Server := sgcHTTPServer1;
OpenAPIServer.LoadFromFile('petstore.yaml');
OpenAPIServer.OnRequest := OpenAPIServerRequest;
sgcHTTPServer1.Port := 8080;
sgcHTTPServer1.Active := True;
end;
procedure TForm1.OpenAPIServerRequest(Sender: TObject;
const aOperationId: string; const aContext: TsgcOpenAPIServerContext;
var Handled: Boolean);
begin
if aOperationId = 'getPetById' then
begin
aContext.RespondJSON(200,
'{"id":"' + aContext.PathParamAsString('petId') + '","name":"Rex"}');
Handled := True;
end;
end;Object Pascal でも C++ Builder でも同じ形です。完全な機能マトリックス →
sgcREST が求めるもの、そして求めないものです。どちらの答えも短く、細かい注記の中ではなく、このページに書いてあります。
コンポーネント 役割
TsgcHTTPRESTServer REST API を公開: CORS、
/metrics、/health、テナンシー
TsgcWSAPIServer_OpenAPI OpenAPI 3.x コントラクトから
REST API を公開
TsgcOpenAPI_Client OpenAPI で記述された任意の API を利用
サーバー側の 2 つのコンポーネントはどちらも TsgcHTTPServer
のサブクラスなので、他の sgcWebSockets サーバーと
同じ Port、TLSOptions、Authentication に
アタッチできます。単体で完結しており、sgcWebSockets Core ランタイムが含まれています。REST サーバーと OpenAPI サーバーがどちらも動作する HTTP/TLS サーバースタックと、OpenAPI クライアントがレスポンスをデコードする JSON レイヤーです。インストーラーは 1 つ、完全なソースコードが箱の中に入っています。
TsgcHTTPRESTServer と、OpenAPI サーバーがアタッチする HTTP サーバーは、どちらも TsgcHTTPServer のサブクラスです。そのため、どちらが API を公開していても、CORS、TLS、Authentication、リクエストパイプラインは同じように動作します。
TsgcOpenAPI_Client は、パス、ヘッダー、認証を OpenAPI ドキュメントから直接解決し、Core ランタイムの素の HTTPS スタック上で動作します。
sgcREST は、Delphi 7 から RAD Studio 13 まで、そして C++ Builder をターゲットにしています。REST サーバーは sgcWebSockets の Professional エディション以上にも含まれており、OpenAPI サーバーとクライアントは既存の sgcOpenAPI パックにも同梱されているため、既存のライセンスですでにカバーされている場合があります。無料体験版インストーラーは sgcWebSockets All-Access の体験版なので、今日にも 3 つのクラスすべてを評価できます。
sgcREST は、制御できないコードジェネレーターをラップするのではなく、契約が記述する REST と OpenAPI のインターフェースを直接実装しているため、リクエスト、検証、ディスパッチはすべて第一級のメソッドとイベントであり、完全なソースコードにより、その間に何もブラックボックスは存在しません。
sgcREST は、Delphi、C++ Builder、.NET 向けの eSeGeCe コンポーネントライブラリ 13 製品のひとつです。共通の設計思想を持ち、完全なソースが付属し、ロイヤリティフリーで配布できます。
Delphi と C++ Builder 向けの REST サーバー、OpenAPI サーバー、OpenAPI クライアントコンポーネントです。単体製品で、sgcWebSockets Core ランタイムを同梱しています。
詳しく見る →Delphi と C++ Builder 向けの HTTP/2 クライアント、gRPC クライアント、そして Google Cloud の Pub/Sub、Calendar、FCM クライアントです。単体製品で、sgcWebSockets Core ランタイムを同梱しています。
詳しく見る →Delphi と C++ Builder 向けの OAuth2 クライアント、JWT クライアント、WebAuthn 対応。単体製品で、sgcWebSockets Core ランタイムを同梱しています。
詳しく見る →Delphi、C++ Builder、Lazarus、.NET 向けの WebSocket、HTTP/2、MQTT、AMQP、WebRTC、AI、そして 30 を超える API 統合。Enterprise エディションには gRPC も含まれています。
詳しく見る →Delphi と C++ Builder 向けの MQTT、AMQP 0.9.1 および 1.0、Apache Kafka、STOMP のクライアントコンポーネント。単体製品で、sgcWebSockets Core ランタイムを同梱しています。
詳しく見る →Delphi と C++ Builder 向けの Telegram および WhatsApp Business のクライアントコンポーネント。単体製品で、sgcWebSockets Core ランタイムを同梱しています。
詳しく見る →生の QUIC トランスポートと HTTP/3 のクライアントおよびサーバー、WebTransport 対応。sgcWebSockets Enterprise のアドオンです。
詳しく見る →Delphi と C++ Builder 向けの AI、LLM、MCP コンポーネント。1 つのコンポーネントで 7 社の LLM プロバイダーに対応し、MCP、埋め込み、音声も利用できます。単体製品で、sgcWebSockets Core ランタイムを同梱しています。
詳しく見る →OpenAPI 3.x パーサー、ネイティブ Pascal SDK ジェネレーター、OpenAPI サーバーコンポーネント、そして 1,195 以上のビルド済みクラウド SDK。
詳しく見る →世界中の Delphi、C++ Builder、Lazarus、.NET 開発者から信頼されています。
Your sgcWebSockets library is very useful and easy to setup. Keep up the good work!
sgcWebSockets is amazing and your support is the best!
Thanks so much for your help and support, I love your components.