Ana içeriğe geç

Yükleme ve Tanım Dosyası Bilgileri

Yükleme Bilgileri​

Yükleme bilgileri bölümü, API Proxy'in hangi ortamlara yüklendiğinin ve bu ortamdaki erişim adresinin görüntülendiği bölümdür. Bir API Proxy, aynı anda birden fazla ortama yüklenebilir.

Eğer API Proxy'den bir API Proxy Group oluşturulmuşsa o gruba ait bilgiler de bu alanda görüntülenir.

Yükleme Bilgileri

Yükleme Bilgileri Alanları​

AlanAçıklama
Ortam (Environment)API Proxy'nin yüklenmiş olduğu Ortam bilgisidir.
Erişim Tipi (Access Type)API Proxy'nin erişim tipinin bilgisidir.
URLAPI Proxy'nin erişim adresidir. Geçit Adresi ve yüklenen Ortamın erişim adresi kullanılarak otomatik olarak üretilir.
Tanım Dosyaları (Specs)API Proxy'nin Tanım dosyalarıdır. Her API Proxy için Swagger ve OpenAPI formatlarında tanım dosyaları üretilir. Eğer API Proxy'nin tipi SOAP ise WSDL ve XSD tanım dosyaları da üretilecektir. Herhangi bir ortam için Göster (Show) bağlantısına tıklandığında, API Proxy'nin o ortam için geçerli olan API Tanım Dosyaları görüntülenir.

Tanım Dosyalarını Görüntüleme​

Göster (Show) butonuna tıklandığında farklı tip ve formattaki API Proxy tanımlarını gösteren dialog açılır:

Tanım Dosyaları Dialog
uyarı

Eğer ilgili API Proxy bir Gruba dahilse ve API Proxy Grup ekranından API Proxy'lere Direkt Erişimi Engelle seçeneği seçilmiş ise, bu bölümde bir uyarı kutucuğu görüntülenir.

Tanım Dosyalarına API Proxy Üzerinden Erişim​

Tanım dosyalarının içeriği, Göster (Show) bağlantısına tıklandığında yukarıdaki şekilde görüldüğü gibi açılır ve buradan kopyalanabilir. Ancak bu yöntem Apinizer platformu üzerinde çalışmakta olan API Geliştirici, API Testçi gibi rollerden kullanıcılar içindir. İstemciler bu arayüzlere erişemez.

İstemciler, tanım dosyalarına erişmek için API Proxy'nin yüklenmiş olduğu Ortamdaki erişim adresini aşağıdaki şekilde kullanabilirler:

Örneğin API Proxy'nin Production Ortamındaki erişim adresi https://demo.apinizer.com/apigateway/petstoreProxy olsun.

Tanım dosyalarına erişim için aşağıdaki adreslere istek gönderilebilir:

Swagger 2.x (JSON)​

  • https://demo.apinizer.com/apigateway/petstoreProxy?swagger
  • https://demo.apinizer.com/apigateway/petstoreProxy?swagger&format=json
  • https://demo.apinizer.com/apigateway/petstoreProxy?swagger.json

Swagger 2.x (YAML)​

  • https://demo.apinizer.com/apigateway/petstoreProxy?swagger&format=yaml
  • https://demo.apinizer.com/apigateway/petstoreProxy?swagger.yaml

OpenAPI 3.x (JSON)​

  • https://demo.apinizer.com/apigateway/petstoreProxy?openapi
  • https://demo.apinizer.com/apigateway/petstoreProxy?openapi&format=json
  • https://demo.apinizer.com/apigateway/petstoreProxy?openapi.json

OpenAPI 3.x (YAML)​

  • https://demo.apinizer.com/apigateway/petstoreProxy?openapi&format=yaml
  • https://demo.apinizer.com/apigateway/petstoreProxy?openapi.yaml

WSDL (API Proxy SOAP ise)​

  • https://demo.apinizer.com/apigateway/calc?wsdl

JWK Set (imza ve şifreleme anahtarları)​

Gateway, bir API Proxy'nin JOSE politikalarında kullanılan public anahtarları JSON Web Key Set (JWKS) olarak yayınlar. İstemciler bu adreslerden aldıkları anahtarlarla imzalı yanıtları doğrulayabilir veya API Proxy'ye göndereceği içeriği şifreleyebilir.

Bu adresler API tanım dosyası değildir; ?swagger veya ?openapi isteği JWK içeriği dönmez.

Örnek taban adres: https://demo.apinizer.com/apigateway/petstoreProxy

Adresİçerik
https://demo.apinizer.com/apigateway/petstoreProxy?jwk-sign.jsonİmza / imza doğrulama (JWS) anahtarları
https://demo.apinizer.com/apigateway/petstoreProxy?jwk-enc.jsonŞifreleme / şifre çözme (JWE) anahtarları

Set hangi anahtarlardan oluşur?​

Set, API Proxy'ye bağlı (API Proxy, endpoint ve hata akışındaki) JOSE Doğrulama ve JOSE Uygulama politikalarında seçilen JWK'lardan oluşur:

  • ?jwk-sign.json → politikalarda imza ve doğrulama için seçilen JWK'lar
  • ?jwk-enc.json → politikalarda şifreleme ve şifre çözme için seçilen JWK'lar

Her anahtar, JWK tanımındaki kid, alg ve use gibi alanlarla döner.

Yanıt​

  • Yanıt her zaman 200 durum kodu ve application/json içerik tipiyle döner.
  • Yanıtta yalnızca public anahtar bilgisi bulunur (RFC 7517 keys dizisi). Private key ve gizli anahtar materyali dönmez.
  • API Proxy'de ilgili türde anahtar seçilmiş bir JOSE politikası yoksa yanıt boş bir settir: {"keys":[]}.
{
"keys": [
{
"kty": "RSA",
"kid": "petstore-sign-key",
"use": "sig",
"alg": "RS256",
"n": "0vx7agoebGcQSuu...",
"e": "AQAB"
}
]
}
uyarı

API Tanım Dosyası Erişim Kontrolü yalnızca ?wsdl, ?wadl, ?swagger, ?openapi ve ?xsd isteklerine uygulanır. JWK Set adresleri bu kontrolden geçmez; tanım dosyalarına erişimi kısıtlamış olsanız bile ?jwk-sign.json ve ?jwk-enc.json erişilebilir kalır. Bu adreslerden yalnızca public anahtarlar döndüğü için bu bir güvenlik açığı değildir, ancak anahtar listesinin dışarıdan görülebileceğini hesaba katın.

Sonraki Adımlar​