sgcREST'in yaptığı her şey; REST sunucusu ve yardımcıları, OpenAPI sunucu motoru ve OpenAPI istemci ailesi üzerinden eşlenmiş. Her yetenek Delphi ve C++ Builder'da aynı şekilde çalışır ve her lisans tam kaynak koduyla gelir. Bu lansman için bileşen alt sayfaları henüz yayımlanmadı, aşağıdaki her giriş bu sayfada kendi kendine yeterlidir.
CORS, istatistikler, kiracılık & kullanıcılar
Spesifikasyon öncelikli & kod öncelikli
OpenAPI ile tanımlanmış herhangi bir API'yi tüketin
Delphi 7'den 13'e, C++ Builder
sgcREST kendi kendine yeterlidir. sgcWebSockets Core çalışma zamanı pakete dahil olarak gelir, bu yüzden bir eklenti değildir, ve RAD Studio ile birlikte gelen standart Indy kitaplığı üzerinde çalışır.
Kod öncelikli OpenAPI, Delphi XE7 veya sonrasını gerektirir. Öznitelikli bir Delphi sınıfından bir spesifikasyon üretmek, XE7 ile gelen RTTI'ye dayanır. REST sunucusu, yardımcıları ve spesifikasyon öncelikli OpenAPI motoru, Delphi 7'den 13'e çalışır.
SGC REST palet sayfasında dört bileşen ve üç kod-yalnızca OpenAPI sunucu ve istemci sınıfı, sgcHTTP_REST_Server* ve sgcHTTP_OpenAPI_* birimlerinde tanımlanmıştır.
| Bileşen | Sınıf | Palette mi? | Açıklama |
|---|---|---|---|
| REST Sunucusu | TsgcHTTPRESTServer | Evet | TsgcHTTPServer üzerine kurulu REST API sunucusu; CORS işleme ve takılabilir istatistik/kiracılık yardımcılarıyla. |
| REST Sunucu İstatistikleri | TsgcHTTPServerStats | Evet | İstek sayaçları, gecikme izleme, Prometheus /metrics ve JSON /health. |
| REST Sunucu Kiracılığı | TsgcHTTPServer_Tenancy | Evet | Ana bilgisayar, yol, başlık veya JWT talebine göre çoklu kiracı çözümlemesi. |
| REST Sunucu Kullanıcıları | TsgcHTTPServer_Users | Evet | Yerel hesap deposu: kullanıcı ekleme, doğrulama, karma oluşturma, rol etiketleme ve kalıcı saklama. |
| OpenAPI Sunucusu, Spesifikasyon Öncelikli | TsgcOpenAPIServerHandler | Hayır, kod-yalnızca | Yüklenmiş bir OpenAPI 3.0/3.1 belgesinden, istek doğrulamasıyla birlikte bir API sunar. |
| OpenAPI Sunucusu, Kod Öncelikli | TsgcOpenAPICodeFirstScanner | Hayır, kod-yalnızca | RTTI ile öznitelikli bir Delphi sınıfından OpenAPI spesifikasyonu üretir. Delphi XE7+ gerektirir. |
| OpenAPI İstemcisi | TsgcOpenAPI_Client | Hayır, kod-yalnızca | OpenAPI ile tanımlanmış herhangi bir uç nokta için genel amaçlı çalışma zamanı istemcisi. |
TsgcHTTPRESTServer, bir TsgcHTTPServer türevidir, bu yüzden her sgc HTTP sunucusunun paylaştığı aynı bağlamalar ve TLS işlemesiyle başlar ve üzerine bir REST API'sinin alışılmış ekstralarını ekler.
| Yetenek | API | Notlar |
|---|---|---|
| CORS | CORSOptions (Enabled, AllowOrigins, AllowHeaders, AllowMethods) | Varsayılan olarak kapalı. Etkinleştirildikten sonra ön kontrol OPTIONS istekleri otomatik olarak yanıtlanır. |
| İstatistik yardımcısı | ServerStats: TsgcHTTPServerStats | Bir istatistik bileşeni ekleyin, her istek rota işleyicilerine dokunmadan sayılır ve zamanlanır. |
| Kiracılık yardımcısı | Tenancy: TsgcHTTPServer_Tenancy, Tenant | Çağıranın kiracısını çözmek için bir kiracılık bileşeni ekleyin; Tenant geçerli istek için sonucu okur. |
| İstek sayaçları | TotalRequests, Status1xx ile Status5xx arası | TsgcHTTPServerStats üzerinde. Yanıtlar gönderildikçe durum sınıfına göre sayılır. |
| Gecikme | LatencyMinMs, LatencyAvgMs, LatencyMaxMs | TsgcHTTPServerStats üzerinde istek başına izlenir, Reset ile sıfırlanır. |
| Metrik uç noktası | GetMetricsText, IsMetricsRequest | Prometheus metin sunum biçimi 0.0.4, /metrics üzerinde sunulur. |
| Sağlık uç noktası | GetHealthJSON, IsHealthRequest | /health üzerinde sunulan JSON sağlık yükü, UptimeSeconds ve ActiveConnections içerir. |
| Uç nokta başına istatistik | GetEndpointStats, Endpoints | Bir rapor ya da yönetici konsolu için, uç nokta başına bir yol/sayı çifti. |
| Kiracı çözümlemesi | Resolution, ResolveTenant | TsgcHTTPServer_Tenancy üzerinde. Ana bilgisayar soneki, yol segmenti, başlık veya JWT talebine göre çözer. |
| Kiracı kaynakları | HostSuffix, PathSegmentIndex, HeaderName, ClaimName, DefaultTenant | Yapılandırılan Resolution modu için okunan kaynak ve hiçbir sonuç vermediğinde kullanılan yedek. |
| Özel çözümleme | OnResolveTenant | Yerleşik çözümleme mantığını geçersiz kılın veya genişletin. |
| Kullanıcı hesapları | AddUser, DeleteUser, FindUser, ValidateCredentials, SetPassword, EnableUser, UserExists | TsgcHTTPServer_Users üzerinde. Tuzlanmış, karması alınmış kimlik bilgileri, asla düz biçimde döndürülmez. |
| Roller | AddRole, RemoveRole, UserHasRole, GetUserRoles | Hesap başına serbest biçimli rol etiketleri, bir rota işleyicisinden denetlenir. |
| Numaralandırma | Count, GetUserCount, GetUserByIndex, GetUsernames | Bir rapor ya da yönetici konsolu için salt okunur görünümler; parola karması ve tuzu asla dahil edilmez. |
| Kalıcılık | LoadUsers, SaveUsers, SaveToFile, LoadFromFile, ExportUsers, ImportUsers | Storage.EncryptAtRest depoyu şifreler; OnLoadUsers/OnSaveUsers özel bir arka uçla değiştirir. |
| Olaylar | OnStats, OnResolveTenant, OnValidateCredentials, OnFindUser, OnException | Yerleşik mantığın kapsamadığı durumlar için yardımcı başına bir olay. |
Her iki yaklaşım da aynı rota tablosunu ve istek bağlamını besler; yalnızca OpenAPI belgesinin kaynağı farklıdır.
| Yetenek | API | Notlar |
|---|---|---|
| Rota tablosu | TsgcOpenAPIRouteTable (Add, Match) | Bir spesifikasyonun paths bölümünden oluşturulur; bir fiil ve yolu bir operationId'ye eşler. |
| İstek bağlamı | TsgcOpenAPIServerContext (Request, Response, PathParams, QueryParams) | Eşleşen istek başına bir örnek, istek bittiğinde serbest bırakılır. |
| Tiplenmiş parametreler | PathParamAsString, PathParamAsInteger, QueryParamAsString, QueryParamAsInteger, QueryParamAsBoolean | Bir yol veya sorgu değerini tek çağrıda okur ve dönüştürür. |
| Gövde erişimi | BodyAsString, BodyAsJSON, HeaderValue | İstek gövdesini bir kez ayrıştırır ve sonucu önbelleğe alır. |
| Yanıtlama | RespondJSON, RespondError | Bir durum koduyla JSON gövdesi yazar veya yapılandırılmış bir hata yükü döner. |
| İstek yaşam döngüsü | BeforeHandle, AfterHandle, HandleException | TsgcOpenAPIServerHandler üzerinde. Günlükleme, yetkilendirme kontrolleri veya özel hata eşlemesi eklemek için geçersiz kılın. |
| Doğrulama | TsgcOpenAPIJSONValidator | İstek gövdelerini, sorgu ve yol parametrelerini spesifikasyonun bildirdiği JSON Şemalarına göre denetler. |
| Spesifikasyon üretimi | GenerateSpec, Title, Description, Version, BasePath | TsgcOpenAPICodeFirstScanner üzerinde. Öznitelikli bir sınıfın RTTI'sinden bir OpenAPI 3.0 belgesi üretir. |
| Sözleşme öznitelikleri | sgcServiceContract, sgcRoute, sgcSummary, sgcDescription, sgcTag, sgcResponse | Üretilen spesifikasyonu dolduran sınıf ve metot düzeyi öznitelikler. |
| Fiil öznitelikleri | sgcHttpGet, sgcHttpPost, sgcHttpPut, sgcHttpDelete, sgcHttpPatch, sgcHttpHead, sgcHttpOptions | İşaretlenmiş bir metodun yanıtladığı HTTP fiilini bildirir. |
| Parametre bağlama | sgcFromPath, sgcFromQuery, sgcFromHeader, sgcFromBody, sgcRequired | Her metot parametresinin nereden okunacağını bildirir. |
| Gönderim | TsgcOpenAPICodeFirstDispatcher (RegisterController, DispatchOperation, IsRegistered) | Bir operationId için kayıtlı işaretlenmiş metodu doğrudan çağırır, elle bir if zinciri gerekmez. |
| Bağımlılık | Delphi XE7 veya sonrası | Kod öncelikli tarama ve gönderim, XE7'den önce bulunmayan System.Rtti'ye dayanır. Spesifikasyon öncelikli yaklaşımın böyle bir gereksinimi yoktur. |
OpenAPI ile tanımlanmış herhangi bir uç nokta için genel bir istemci; Basic kimlik doğrulama, bearer token, genel OAuth2 ve genel JWT yerleşik olarak gelir.
| Yetenek | API | Notlar |
|---|---|---|
| Temel çağrı | HTTP_REQUEST | TsgcOpenAPI_Client üzerinde. Herhangi bir uç noktaya bir TsgcOpenAPIRequest/TsgcOpenAPIResponse çiftini taşır. |
| Temel URL | SetBaseURL, GetBaseURL | Bir istekteki her göreli yolun çözüldüğü uç nokta. |
| Genel kimlik doğrulama | Authentication (Basic, Token, OAuth2, JWT) | Basic kimlik doğrulama ve bearer token'ların yanı sıra genel OAuth2 ve JWT akışları. |
| Taşıma | TLSOptions, ProxyOptions, EncodeBodyAsUTF8 | sgc HTTP yığınının geri kalanıyla paylaşılan standart TLS ve proxy yapılandırması. |
| İlerleme & günlükleme | OnUpload, OnDownload, Log, LogFileName | Büyük istek/yanıt gövdelerini izleyin ve isteğe bağlı olarak her çağrıyı bir dosyaya günlükleyin. |
| İstek kancası | OnBeforeRequest | Bir isteği gönderilmeden önce inceleyin veya değiştirin. |
| TLS kancaları | OnSSLVerifyPeer, OnSSLGetHandler, OnSSLAfterCreateHandler | Sertifika doğrulama ve işleyici özelleştirmesi, sgc HTTP yığınının geri kalanıyla paylaşılır. |
Hat üzerinde kamuya açık standartlar ve desteklenen her derleyicide aynı kaynak kodu.
| Alan | Ayrıntı |
|---|---|
| OpenAPI | Hem sunucunun spesifikasyon öncelikli yönlendirmesi hem de istek doğrulamasının denetlediği JSON Şemaları için OpenAPI 3.0 ve 3.1. |
| İstemci kimlik doğrulama | HTTP Basic kimlik doğrulama ve bearer token'lar, ayrıca genel OAuth2 ve JWT. |
| Metrikler | /metrics üzerinde Prometheus metin sunum biçimi 0.0.4. |
| Platformlar | Yedi sınıfın tümü için Windows Win32, Windows Win64, Linux64, macOS, iOS ve Android. |
| Bağımlılık | Pakete dahil sgcWebSockets Core çalışma zamanının ötesinde yok. Yedi sınıfın hiçbiri için ek bir eklenti gerekmez. |
| Derleyiciler | Delphi ve C++ Builder 7'den 13'e. Kod öncelikli OpenAPI, Delphi XE7 veya sonrasını gerektirir. |
| Sürümler | REST sunucu ailesi ayrıca sgcWebSockets içinde Professional sürümünden itibaren, OpenAPI sunucusu Enterprise'dan itibaren ve OpenAPI istemcisi Standard'dan itibaren gelir. |
| Lisanslama | Bağımsız. sgcWebSockets Core çalışma zamanı pakete dahildir ve tam kaynak kodu içerilir. |