Trzy komponenty pokrywają dwa zadania. TsgcHTTPRESTServer to serwer REST z obsługą CORS, opcjonalnymi punktami końcowymi /metrics i /health oraz wbudowanym rozpoznawaniem dzierżawcy dla każdego żądania. TsgcWSAPIServer_OpenAPI wczytuje kontrakt OpenAPI 3.x przez LoadFromFile i na jego podstawie rozdziela, waliduje i uwierzytelnia każde żądanie. TsgcOpenAPI_Client to klasa bazowa, na której zbudowani są typowani klienci dla dowolnego API opisanego w OpenAPI. Samodzielnie, środowisko uruchomieniowe sgcWebSockets Core jest w zestawie.
sgcREST to pakiet samodzielny. Zawiera środowisko uruchomieniowe sgcWebSockets Core, na którym jest zbudowany, a każda licencja jest dostarczana z pełnym kodem źródłowym, więc trasowanie REST i walidację OpenAPI prześledzisz we własnym debugerze.
TsgcHTTPRESTServer na stronie palety SGC REST, TsgcWSAPIServer_OpenAPI na stronie palety SGC OpenAPI.
/metrics i /health, opcjonalne i serwowane za takim uwierzytelnianiem (Authentication), jakie serwer już wymusza.
Komponenty serwera REST oraz serwera/klienta OpenAPI dla Delphi i C++ Builder. Pakiet samodzielny z dołączonym środowiskiem uruchomieniowym sgcWebSockets Core, pełnym kodem źródłowym i wdrożeniem bez opłat licencyjnych.
Trzy klasy dzielą się wyraźnie według kierunku. Serwer REST i serwer OpenAPI publikują punkty końcowe, do których docierają twoi wywołujący. Klasa bazowa klienta OpenAPI to ta, na której wygenerowane SDK wywołują cudze punkty końcowe.
TsgcHTTPRESTServer rozszerza serwer HTTP sgcWebSockets o codzienne mechanizmy, których potrzebuje API REST: CORSOptions dla żądań cross-origin, opcjonalne punkty końcowe /metrics i /health przez ServerStats oraz rozpoznawanie dzierżawcy dla każdego żądania przez Tenancy, na podstawie hosta, ścieżki, nagłówka lub oświadczenia JWT. Tenant udostępnia rozpoznaną wartość twoim własnym procedurom obsługi żądań.
TsgcWSAPIServer_OpenAPI wczytuje dokument OpenAPI 3.x przez LoadFromFile lub LoadFromString i zamienia go w żywy dyspozytor: każde nadchodzące żądanie jest dopasowywane do kontraktu i kierowane do twojej procedury OnRequest według identyfikatora operacji. OnValidationError, OnAuthenticate, OnValidateAPIKey, OnValidateBasic i OnValidateBearer obsługują schematy zabezpieczeń zadeklarowane w specyfikacji, a OnBeforeRequest/OnAfterRequest obejmują całe wywołanie.
TsgcOpenAPI_Client to uniwersalny klient uruchomieniowy dla dowolnego API opisanego w OpenAPI: Authentication obejmuje uwierzytelnianie Basic, token bearer, ogólne OAuth2 i JWT, a HTTP_REQUEST i HTTP_REQUEST_Async wykonują wywołanie. Wskaż SetBaseURL na wczytany albo samodzielnie wygenerowany kontrakt, a klient jest gotowy do użycia.
OnException przechwytuje błędy procedury obsługi, zanim trafią na łącze, a zdarzenia walidacji i uwierzytelniania otrzymują sparsowany TsgcOpenAPIServerContext, z PathParams, QueryParams i RespondJSON, więc nic w tym, dlaczego wywołanie zostało przyjęte albo odrzucone, nie jest przed tobą ukryte.
Serwer REST i serwer OpenAPI są potomkami TsgcHTTPServer, a klient OpenAPI działa na tym samym stosie HTTPS co reszta środowiska uruchomieniowego Core. Od Delphi 7 po RAD Studio 13, także w C++ Builder.
Strony referencyjne każdego komponentu:
Serwer REST przekazuje ci żądanie bezpośrednio. Serwer OpenAPI przekazuje ci już zwalidowaną, dopasowaną operację. Oba kompilują się tak samo w Delphi od 7 do 13 oraz w 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;Ten sam kształt w Object Pascalu i w C++ Builder. Pełna matryca funkcji →
Czego sgcREST od ciebie wymaga i czego nie potrzebuje. Obie odpowiedzi są krótkie i obie znajdziesz na tej stronie, a nie drobnym drukiem.
komponent rola
TsgcHTTPRESTServer publikuje API REST: CORS,
/metrics, /health, wielodostępność
TsgcWSAPIServer_OpenAPI publikuje API REST na podstawie
kontraktu OpenAPI 3.x
TsgcOpenAPI_Client korzysta z dowolnego API opisanego w OpenAPI
Oba komponenty serwerowe są potomkami TsgcHTTPServer,
więc podpinają się pod ten sam Port, TLSOptions
i Authentication, których używają już twoje
pozostałe serwery sgcWebSockets.Samodzielnie, środowisko uruchomieniowe sgcWebSockets Core jest w zestawie: stos serwera HTTP/TLS, na którym działają zarówno serwer REST, jak i serwer OpenAPI, oraz warstwa JSON, którą klient OpenAPI dekoduje odpowiedzi. Jeden instalator, pełny kod źródłowy w pakiecie.
TsgcHTTPRESTServer oraz serwer HTTP, do którego podpina się serwer OpenAPI, są potomkami TsgcHTTPServer, więc CORS, TLS, Authentication i potok żądań zachowują się tak samo, niezależnie od tego, który z nich publikuje twoje API.
TsgcOpenAPI_Client rozwiązuje ścieżki, nagłówki i uwierzytelnianie wprost z dokumentu OpenAPI, przez zwykły stos HTTPS środowiska uruchomieniowego Core.
sgcREST jest przeznaczony dla Delphi od 7 do RAD Studio 13 oraz C++ Builder. Serwer REST znajdziesz także wewnątrz sgcWebSockets od edycji Professional wzwyż, a serwer i klient OpenAPI są dostarczane również z istniejącym pakietem sgcOpenAPI, więc może już obejmować cię istniejąca licencja. Bezpłatny instalator próbny to wersja próbna sgcWebSockets All-Access, więc wszystkie trzy klasy możesz wypróbować już dziś.
sgcREST implementuje powierzchnie REST i OpenAPI opisane w twoim kontrakcie, zamiast opakowywać generator kodu, nad którym nie masz kontroli, więc żądania, walidacja i trasowanie są w pełni pierwszorzędnymi metodami i zdarzeniami, a pełny kod źródłowy oznacza, że nic pomiędzy nimi nie jest czarną skrzynką.
sgcREST to jedna z trzynastu bibliotek komponentów eSeGeCe dla Delphi, C++ Builder i .NET. Dzielą te same konwencje, dostarczane są z pełnym kodem źródłowym i wdrażane bez opłat licencyjnych.
Serwer REST, serwer OpenAPI oraz komponenty klienta OpenAPI dla Delphi i C++ Builder. Publikuj API REST na podstawie kontraktu OpenAPI 3.x albo korzystaj z dowolnego API opisanego w OpenAPI. Produkt samodzielny, z dołączonym środowiskiem uruchomieniowym sgcWebSockets Core.
Dowiedz się więcej →Klient HTTP/2, klient gRPC oraz klienty Google Cloud Pub/Sub, Calendar i FCM dla Delphi i C++ Builder. Produkt samodzielny, z dołączonym środowiskiem uruchomieniowym sgcWebSockets Core.
Dowiedz się więcej →Klient OAuth2, klient JWT i obsługa WebAuthn dla Delphi i C++ Builder. Produkt samodzielny, z dołączonym środowiskiem uruchomieniowym sgcWebSockets Core.
Dowiedz się więcej →WebSocket, HTTP/2, MQTT, AMQP, WebRTC, AI oraz ponad 30 integracji API dla Delphi, C++ Builder, Lazarus i .NET. Jej edycja Enterprise zawiera także gRPC.
Dowiedz się więcej →Komponenty klienckie MQTT, AMQP 0.9.1 i 1.0, Apache Kafka oraz STOMP dla Delphi i C++ Builder. Produkt samodzielny, z dołączonym środowiskiem uruchomieniowym sgcWebSockets Core.
Dowiedz się więcej →Komponenty klienckie Telegram i WhatsApp Business dla Delphi i C++ Builder. Produkt samodzielny, z dołączonym środowiskiem uruchomieniowym sgcWebSockets Core.
Dowiedz się więcej →Serwerowe komponenty HTML i UI na Bootstrap 5 i htmx dla Delphi, C++ Builder i .NET.
Dowiedz się więcej →Surowy transport QUIC oraz klient i serwer HTTP/3, z WebTransport. Dodatek do sgcWebSockets Enterprise.
Dowiedz się więcej →Komponenty AI, LLM i MCP dla Delphi oraz C++ Builder. Siedmiu dostawców LLM za jednym komponentem, a do tego MCP, embeddingi i mowa. Produkt samodzielny, z dołączonym środowiskiem uruchomieniowym sgcWebSockets Core.
Dowiedz się więcej →Parser OpenAPI 3.x, natywny generator SDK w Pascalu, komponent serwera OpenAPI oraz ponad 1 195 gotowych SDK chmurowych.
Dowiedz się więcej →XAdES, PAdES, CAdES i ASiC dla dokumentów, Authenticode, ClickOnce, NuGet i VSIX dla kodu.
Dowiedz się więcej →Windows Hello, czytniki linii papilarnych i Windows Biometric Framework dla Delphi i C++ Builder.
Dowiedz się więcej →Zaktualizowane komponenty Indy TCP/IP z nowoczesnym TLS, IPv6 i HTTP/2 od Delphi 7 do 13.
Dowiedz się więcej →Zaufali nam programiści Delphi, C++ Builder, Lazarus i .NET na całym świecie.
Wasza biblioteka sgcWebSockets jest bardzo przydatna i łatwa w konfiguracji. Tak trzymać!
sgcWebSockets jest niesamowity, a wasze wsparcie jest najlepsze!
Bardzo dziękuję za pomoc i wsparcie, uwielbiam wasze komponenty.