Hızlı Başlangıç Aşağıda örnek bir API Proxy oluşturulurken izlenen adımlar Hızlı Başlangıç sayfasında anlatılanlarla aynı olmakla birlikte, bu bölümde veri alanlarına ilişkin açıklamalar bulunmaktadır.
API Proxy Oluşturma Adımları
1- Ana menüde Geliştirme → API Proxy’ler (Development → API Proxies) ögesi seçilir. 2- Açılan arayüzde sağ üstteki +Add API Proxy butonuna tıklanır.
API Proxy Tipleri
Oluşturulacak API Proxy için uygun tip seçilir. Mevcut API Proxy tipleri aşağıdaki tabloda açıklanmıştır.| Tip | Açıklama |
|---|---|
| Swagger 2.x | Swagger 2.x tanımından REST API Proxy oluşturmak için kullanılır. Detaylı bilgi için buraya tıklayınız. |
| WSDL (SOAP) | WSDL tanımından SOAP API Proxy oluşturmak için kullanılır. Detaylı bilgi için buraya tıklayınız. |
| OpenAPI/Swagger 3.0.x | OpenAPI/Swagger 3.0.x tanımından REST API Proxy oluşturmak için kullanılır. Detaylı bilgi için buraya tıklayınız. |
| Reverse Proxy | HTTP Reverse Proxy oluşturmak için kullanılır. Gelen istekleri, ilgili metot/endpoint olup olmadığına bakmaksızın Backend API’ye iletir ve Backend API’den dönen yanıtları istemciye geri döndürür. Tanım dosyasına gerek yoktur ve Backend API’nin metotlarını/endpointlerini tek tek tanımlamaya gerek yoktur. Backend API’nin kök bağlamını (root context) vermek yeterlidir. |
| No-Spec API | Daha önce code-first yaklaşımıyla geliştirilmiş ve tanım dosyası olmayan bir API için, metotları/endpointleri manuel olarak tanımlama ve API Proxy oluşturma imkanı sağlar. Apinizer, tanımlara göre Swagger veya OpenAPI formatlarında API tanım dosyalarını otomatik olarak oluşturur. |
| gRPC | Gelen gRPC isteklerini Backend gRPC Sunucusuna ileten ve Backend gRPC Sunucusundan dönen yanıtları istemciye geri döndüren gRPC Proxy oluşturmak için kullanılır. Tanım dosyasına gerek yoktur, ancak proto dosyası kullanılabilir. |
| WebSocket | WebSocket Proxy oluşturmak için kullanılır. |
| Connector | Konnektörlerden API proxy’si oluşturma yeteneği sağlar. Bu özellik, HTTP’yi farklı protokollere (Kafka, RabbitMQ, ActiveMQ, Mail… vb gibi) dönüştürme imkanı sağlar. Konnektörler hakkında daha fazla bilgi edinmek için lütfen bu sayfayı ziyaret edin. |
API Tanım Belgesi Kaynağı
Ayrıca seçeneklerin altlarında bazı ek seçenekler olduğu da görülmektedir.| Alan | Açıklama |
|---|---|
| URL Gir (Enter URL) | Kendisi için API Proxy oluşturulacak API’nin API Tanım belgesinin erişilebilir olduğu URL bilinmektedir. Bu URL belirtilerek API Proxy oluşturulabilir. Örnekler: https://petstore.swagger.io/v2/swagger.json, http://www.dneonline.com/calculator.asmx?WSDL |
| Dosya Yükle (Upload File) | Kendisi için API Proxy oluşturulacak API’nin API Tanım belgesi bir dosya olarak kayıtlı halde kullanıcıda ise bu dosya yüklenerek API Proxy oluşturulabilir. |
| API Tanım Belgesi Seç (Select API Spec) | Kendisi için API Proxy oluşturulacak API için, API Tanım Belgesi Editörü (API Spec Creator) ile önceden oluşturulmuş olan bir API Tanım Belgesi kullanılarak API Proxy oluşturulabilir. |
| Alan | Açıklama |
|---|---|
| Spec Authorization Kullan_(Use Spec Authorization)_ | Bazı tanım dosyaları, içeriklerinin görüntülenebilmesi için istemcinin yetkilendirilmiş olduğunu kontrol eder. Bunun için HTTP isteği içerisinde kimlik doğrulama verilerinin gönderilmesi gerekir. Eğer erişilecek URL’deki tanım dosyası böyle bir dosya ise, bu kutu işaretlenerek kimlik bilgilerini girilir. |
| URL | Tanım dosyasına erişilecek adrestir. |
https://petstore.swagger.io/v2/swagger.json adresi yazılıp sağ taraftaki Parse tuşuna tıklanır.
| Alan | Açıklama |
|---|---|
| Adı (Name) | API Proxy’ye kullanıcı tarafından verilen addır. Arayüzlerde bu ad görünür. |
| Açıklama (Description) | API Proxy’nin tanım bilgisidir. |
| Routing Addresses | Backend API’nin erişim adresleri. Status checkbox ile aktif/pasif edilebilir. Birden fazla adres load balancing için eklenebilir. |
| Client Route | İstemcilerin API Proxy’e erişim için kullanacağı yönlendirme yöntemi (Path, Method veya Header bazlı). Relative Paths: API Proxy’nin erişime açılan adresinin bir parçası. Gelen isteklerin uygun API Proxy’e yönlendirilmesi için kullanılır. Örnek: • Apinizer adresi: https://demo.apinizer.com• Relative Path: /petstoreProxy • Ortam adresi: /apigateway • Endpoint: /findByStatus • Tam erişim adresi: https://demo.apinizer.com/apigateway/petstoreProxy/findByStatusDikkat edilmesi gerekenler: • Uygulama bazında tekil olmalıdır • Başka bir path’in başlangıcı olamaz • Proje ayarlarında Enable Relative Path aktifse, proje path’i otomatik önüne eklenir gRPC için: Eğer API Proxy tipi gRPC ise bu değer proto dökümanındaki “/packagename.servicename” şeklinde olmalıdır. Örneğin aşağıdaki gibi bir proto dosyasına sahip ise relative path değeri “/hello.HelloService” şeklinde olmalıdır: proto<br/>syntax = "proto3"<br/>package hello;<br/>service HelloService {<br/>}<br/>WebSocket için: Eğer API Proxy tipi WebSocket ise relative path değerinin nasıl girilmesi gerektiği ile ilgili şu sayfayı ziyaret edebilirsiniz. Methods: API Proxy’nin desteklediği HTTP metodları (GET, POST, PUT, DELETE, PATCH vb.) Hosts: Backend servislerin host adresleri. “Add a host” ile yeni adres eklenebilir. Headers: API Proxy seviyesinde eklenecek HTTP header’ları. “Add a header” ile yeni header eklenebilir. Detaylı bilgi için bakınız: API Proxy Client Route Kullanım Kılavuzu |
| Backend API Versiyon_(Backend API Version)_ | API Proxy’e tanımlanan Backend API Versiyonudur. |
| Kategori Listesi_(Category List)_ | API Proxy’lerin yönetiminde kolaylık sağlamak üzere kategoriler oluşturulabilir. Kategori listesi, API Proxy’nin hangi kategorilere ait olduğunu belirlemek için kullanılır. |
| Kullanım Şekli_(Usage)_ | Backend API’nin kaynağının kim olduğunu belirtir. Alabileceği değerler: Üretici (Publisher): Backend API, firma/kurumun kendisi tarafından açılmıştır. Tüketici (Consumer): Backend API, başka bir firma/kuruma aittir. O API’ye erişmek için API Proxy oluşturulmaktadır. Üretici ve Tüketici (Publisher & Consumer): Başka bir firma/kuruma ait olan bir Backend API için oluşturulan API Proxy, 3. taraflara da kullandırılmak üzere oluşturulmaktadır. |
| Paylaşım Tipi_(Sharing Type)_ | Backend API’nin nasıl paylaşılacağı belirtilir. Alabileceği değerler: Dış (External), İç (Internal), Dış ve İç (External and Internal) |
İlgili Sayfalar
Quick Start
Hızlı başlangıç kılavuzu
Spec Designer
API Tanım Belgesi oluşturma
API Proxy Konfigürasyonu
API Proxy ayarları
SOAP API Proxy
SOAP API Proxy oluşturma
REST API Proxy
REST API Proxy oluşturma
gRPC API Proxy
gRPC API Proxy oluşturma
WebSocket API Proxy
WebSocket API Proxy oluşturma
Connector API Proxy
Connector API Proxy oluşturma
DB API Oluşturma
Veritabanından API oluşturma
Script API Oluşturma
Script ile API oluşturma
Mock API Oluşturma
Mock API oluşturma