Alles wat sgcREST doet, uitgesplitst over de REST-server en zijn companions, de OpenAPI-serverengine en de OpenAPI-clientfamilie. Elke mogelijkheid werkt hetzelfde in Delphi en C++ Builder, en elke licentie bevat de volledige broncode. Voor deze launch zijn er nog geen aparte componentpagina's gepubliceerd, elk onderdeel hieronder staat op zichzelf op deze pagina.
CORS, stats, tenancy & gebruikers
Spec-first & code-first
Consumeer elke OpenAPI-beschreven API
Delphi 7 tot 13, C++ Builder
sgcREST is zelfstandig. Het wordt geleverd met de sgcWebSockets Core runtime inbegrepen, dus het is geen add-on, en het draait op de standaard Indy-bibliotheek die met RAD Studio wordt meegeleverd.
Code-first OpenAPI heeft Delphi XE7 of hoger nodig. Het genereren van een spec vanuit een geannoteerde Delphi-klasse steunt op RTTI die in XE7 is geïntroduceerd. De REST-server, zijn companions en de spec-first OpenAPI-engine draaien op Delphi 7 tot 13.
Vier componenten op de paletpagina SGC REST, en drie code-only OpenAPI-server- en clientklassen, gedeclareerd in de sgcHTTP_REST_Server*- en sgcHTTP_OpenAPI_*-units.
| Component | Klasse | Palet? | Beschrijving |
|---|---|---|---|
| REST-server | TsgcHTTPRESTServer | Ja | REST API-server gebouwd op TsgcHTTPServer, met CORS-afhandeling en koppelbare stats-/tenancy-companions. |
| REST-server Stats | TsgcHTTPServerStats | Ja | Requesttellers, latency-tracking, Prometheus-/metrics en JSON-/health. |
| REST-server Tenancy | TsgcHTTPServer_Tenancy | Ja | Multi-tenant resolutie op host, pad, header of JWT-claim. |
| REST-server Users | TsgcHTTPServer_Users | Ja | Lokale accountopslag: gebruikers toevoegen, valideren, hashen, roltaggen en persisteren. |
| OpenAPI-server, spec-first | TsgcOpenAPIServerHandler | Nee, code-only | Serveert een API vanuit een geladen OpenAPI 3.0/3.1-document, met requestvalidatie. |
| OpenAPI-server, code-first | TsgcOpenAPICodeFirstScanner | Nee, code-only | Genereert de OpenAPI-spec vanuit een RTTI-geannoteerde Delphi-klasse. Heeft Delphi XE7+ nodig. |
| OpenAPI-client | TsgcOpenAPI_Client | Nee, code-only | Generieke runtimeclient voor elk OpenAPI-beschreven endpoint. |
TsgcHTTPRESTServer is een afstammeling van TsgcHTTPServer, dus hij start vanuit dezelfde bindings en TLS-afhandeling die elke sgc HTTP-server deelt, en legt daar de gebruikelijke extra's van een REST API bovenop.
| Mogelijkheid | API | Opmerkingen |
|---|---|---|
| CORS | CORSOptions (Enabled, AllowOrigins, AllowHeaders, AllowMethods) | Standaard uit. Preflight-OPTIONS-requests worden automatisch beantwoord zodra dit is ingeschakeld. |
| Stats-companion | ServerStats: TsgcHTTPServerStats | Koppel een stats-component en elk verzoek wordt geteld en getimed zonder de routehandlers aan te raken. |
| Tenancy-companion | Tenancy: TsgcHTTPServer_Tenancy, Tenant | Koppel een tenancy-component om de tenant van de aanroeper te herleiden; Tenant leest het resultaat voor het huidige verzoek. |
| Requesttellers | TotalRequests, Status1xx tot Status5xx | Op TsgcHTTPServerStats. Geteld per statusklasse zodra responses worden verstuurd. |
| Latency | LatencyMinMs, LatencyAvgMs, LatencyMaxMs | Bijgehouden per verzoek op TsgcHTTPServerStats, gereset met Reset. |
| Metrics-endpoint | GetMetricsText, IsMetricsRequest | Prometheus text exposition format 0.0.4, geserveerd op /metrics. |
| Health-endpoint | GetHealthJSON, IsHealthRequest | JSON-healthpayload geserveerd op /health, inclusief UptimeSeconds en ActiveConnections. |
| Statistieken per endpoint | GetEndpointStats, Endpoints | Eén pad-/telpaar per endpoint, voor een rapport of een adminconsole. |
| Tenant-resolutie | Resolution, ResolveTenant | Op TsgcHTTPServer_Tenancy. Herleidt op hostsuffix, padsegment, header of JWT-claim. |
| Tenant-bronnen | HostSuffix, PathSegmentIndex, HeaderName, ClaimName, DefaultTenant | De bron die wordt gelezen voor de geconfigureerde Resolution-modus, en de fallback wanneer die niets oplevert. |
| Aangepaste resolutie | OnResolveTenant | Override of breid de ingebouwde resolutielogica uit. |
| Gebruikersaccounts | AddUser, DeleteUser, FindUser, ValidateCredentials, SetPassword, EnableUser, UserExists | Op TsgcHTTPServer_Users. Gesalte, gehashte inloggegevens, nooit in platte vorm teruggegeven. |
| Rollen | AddRole, RemoveRole, UserHasRole, GetUserRoles | Vrije roltags per account, gecontroleerd vanuit een routehandler. |
| Enumeratie | Count, GetUserCount, GetUserByIndex, GetUsernames | Alleen-lezen weergaven voor een rapport of een adminconsole; wachtwoordhash en salt worden nooit meegegeven. |
| Persistentie | LoadUsers, SaveUsers, SaveToFile, LoadFromFile, ExportUsers, ImportUsers | Storage.EncryptAtRest versleutelt de opslag; OnLoadUsers/OnSaveUsers wisselen een aangepaste backend in. |
| Events | OnStats, OnResolveTenant, OnValidateCredentials, OnFindUser, OnException | Eén event per companion voor de gevallen die de ingebouwde logica niet dekt. |
Beide aanpakken voeden dezelfde routetabel en request context; alleen de bron van het OpenAPI-document verschilt.
| Mogelijkheid | API | Opmerkingen |
|---|---|---|
| Routetabel | TsgcOpenAPIRouteTable (Add, Match) | Opgebouwd vanuit de paths-sectie van een spec; matcht een werkwoord en een pad aan een operationId. |
| Request context | TsgcOpenAPIServerContext (Request, Response, PathParams, QueryParams) | Eén instantie per gematcht verzoek, vrijgegeven wanneer het verzoek eindigt. |
| Getypeerde parameters | PathParamAsString, PathParamAsInteger, QueryParamAsString, QueryParamAsInteger, QueryParamAsBoolean | Leest en converteert een pad- of querywaarde in één aanroep. |
| Body-toegang | BodyAsString, BodyAsJSON, HeaderValue | Parseert de requestbody eenmalig en cachet het resultaat. |
| Antwoorden | RespondJSON, RespondError | Schrijft een JSON-body met een statuscode, of een gestructureerde foutpayload. |
| Requestlevenscyclus | BeforeHandle, AfterHandle, HandleException | Op TsgcOpenAPIServerHandler. Override om logging, authcontroles of aangepaste foutafhandeling toe te voegen. |
| Validatie | TsgcOpenAPIJSONValidator | Toetst requestbodies, query- en padparameters aan de JSON Schemas die de spec declareert. |
| Specgeneratie | GenerateSpec, Title, Description, Version, BasePath | Op TsgcOpenAPICodeFirstScanner. Produceert een OpenAPI 3.0-document vanuit de RTTI van een geannoteerde klasse. |
| Contractattributen | sgcServiceContract, sgcRoute, sgcSummary, sgcDescription, sgcTag, sgcResponse | Klasse- en methode-attributen die de gegenereerde spec vullen. |
| Werkwoordattributen | sgcHttpGet, sgcHttpPost, sgcHttpPut, sgcHttpDelete, sgcHttpPatch, sgcHttpHead, sgcHttpOptions | Declareert het HTTP-werkwoord dat een geannoteerde methode beantwoordt. |
| Parameterbinding | sgcFromPath, sgcFromQuery, sgcFromHeader, sgcFromBody, sgcRequired | Declareert waar elke methodeparameter vandaan wordt gelezen. |
| Dispatch | TsgcOpenAPICodeFirstDispatcher (RegisterController, DispatchOperation, IsRegistered) | Roept de geannoteerde methode aan die voor een operationId is geregistreerd, rechtstreeks, zonder handmatige if-keten. |
| Afhankelijkheid | Delphi XE7 of hoger | Code-first scanning en dispatch steunen op System.Rtti, niet beschikbaar vóór XE7. Spec-first heeft die vereiste niet. |
Een generieke client voor elk OpenAPI-beschreven endpoint, met Basic auth, bearer tokens, generieke OAuth2 en generieke JWT ingebouwd.
| Mogelijkheid | API | Opmerkingen |
|---|---|---|
| Basisaanroep | HTTP_REQUEST | Op TsgcOpenAPI_Client. Draagt een TsgcOpenAPIRequest/TsgcOpenAPIResponse-paar naar elk endpoint. |
| Basis-URL | SetBaseURL, GetBaseURL | Het endpoint waartegen elk relatief pad in een verzoek wordt opgelost. |
| Generieke authenticatie | Authentication (Basic, Token, OAuth2, JWT) | Basic auth en bearer tokens, plus generieke OAuth2- en JWT-flows. |
| Transport | TLSOptions, ProxyOptions, EncodeBodyAsUTF8 | Standaard TLS- en proxyconfiguratie, gedeeld met de rest van de sgc HTTP-stack. |
| Voortgang & logging | OnUpload, OnDownload, Log, LogFileName | Volg grote request-/responsebodies en log optioneel elke aanroep naar een bestand. |
| Request-hook | OnBeforeRequest | Inspecteer of wijzig een verzoek voordat het wordt verstuurd. |
| TLS-hooks | OnSSLVerifyPeer, OnSSLGetHandler, OnSSLAfterCreateHandler | Certificaatverificatie en handleraanpassing, gedeeld met de rest van de sgc HTTP-stack. |
Publieke standaarden op de lijn, en dezelfde broncode voor elke ondersteunde compiler.
| Gebied | Detail |
|---|---|
| OpenAPI | OpenAPI 3.0 en 3.1, zowel voor de spec-first routing van de server als voor de JSON Schemas waaraan requestvalidatie toetst. |
| Clientauthenticatie | HTTP Basic-authenticatie en bearer tokens, plus generieke OAuth2 en JWT. |
| Metrics | Prometheus text exposition format 0.0.4 op /metrics. |
| Platforms | Windows Win32, Windows Win64, Linux64, macOS, iOS en Android voor alle zeven klassen. |
| Afhankelijkheid | Geen, behalve de meegeleverde sgcWebSockets Core runtime. Geen extra add-on voor een van de zeven klassen. |
| Compilers | Delphi en C++ Builder 7 tot en met 13. Code-first OpenAPI heeft Delphi XE7 of hoger nodig. |
| Edities | De REST-serverfamilie zit ook in sgcWebSockets vanaf Professional, de OpenAPI-server vanaf Enterprise, en de OpenAPI-client vanaf Standard. |
| Licenties | Standalone. De sgcWebSockets Core runtime is meegeleverd en de volledige broncode is inbegrepen. |