API'lerinizi yayınlama (orijinal sürüm)

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Aşağıdaki bölümlerde açıklandığı gibi, uygulama geliştiricilerin kullanımına açık hale getirmek için API'leri portalınızda yayınlayın.

API yayınlamaya genel bakış

API'leri portalınızda yayınlama işlemi iki adımlı bir işlemdir:

1. Portalınızda yayınlamak istediğiniz API ürününü seçin.
2. Uygulama geliştiricilerin API'leriniz hakkında bilgi edinmesini sağlamak için OpenAPI Spesifikasyonunuzun anlık görüntüsünden API referans belgelerini otomatik olarak oluşturun. (Anlık görüntüler hakkında daha fazla bilgi için OpenAPI Specification'ın anlık görüntüsü nedir? konusuna bakın.

Portalınıza bir API yayınladığınızda aşağıdaki güncellemeler portalınızda otomatik olarak yapılır:

• Portalınıza bir API Referansı sayfası eklendi
  API Referansı sayfasında, OpenAPI Specification'ınızın anlık görüntüsünden otomatik olarak oluşturduğunuz API referans belgeleri gösterilir. Geliştiriciler API belgelerinizi inceleyip Dene'yi tıklayarak API isteğinde bulunabilir ve sonucu görüntüleyebilir.

  Not: Bu sayfanın içeriğini doğrudan düzenleyemezsiniz; portalınızdaki sayfalar listesinde görünmez.

  

• API Referansı sayfasının bağlantısı API'ler sayfasına eklenir
  API'ler sayfası (örnek portala dahildir), portalınızda yayınlanan tüm API'lerin bir listesini ve daha fazla bilgi edinmeniz için ilgili API referans belgelerinin bağlantılarını içerir.

  Not: Bu sayfanın içeriğini doğrudan düzenleyemezsiniz; portalınızdaki sayfalar listesinde görünmez.

  

OpenAPI Specification'ın anlık görüntüsü nedir?

Her OpenAPI Spesifikasyonu, bir API'nin yaşam döngüsü boyunca doğru bir bilgi kaynağı olarak işlev görür. Geliştirmeden yayınlamaya ve izlemeye kadar API yaşam döngüsünün her aşamasında aynı spesifikasyon kullanılır. Bir spesifikasyonda değişiklik yaparken, değişikliklerin diğer yaşam döngüsü aşamalarında API'niz üzerindeki etkisinin farkında olmanız gerekir. Bu durum, Spesifikasyonda değişiklik yaparsam ne olur? bölümünde açıklanmıştır.

API'nizi yayınladığınızda, API referans belgelerini oluşturmak için OpenAPI Specification'ın anlık görüntüsünü alırsınız. Bu anlık görüntü, spesifikasyon deposundaki spesifikasyonun belirli bir sürümünü temsil eder. Spesifikasyon düzenleyicisini kullanarak OpenAPI Spesifikasyonu'nda değişiklik yaparsanız API referans belgelerindeki en son değişiklikleri yansıtmak için spesifikasyonun başka bir anlık görüntüsünü almaya karar verebilirsiniz.

API proxy'lerinize CORS desteği ekleme

API'lerinizi yayınlamadan önce, istemci tarafı çapraz kaynak isteklerini desteklemek için API proxy'lerinize CORS desteği eklemeniz gerekir.

CORS (kaynaklar arası kaynak paylaşımı), bir web sayfasında yürütülen JavaScript XMLHttpRequest (XHR) çağrılarının, kaynak olmayan alanlardaki kaynaklarla etkileşim kurmasına olanak tanıyan standart bir mekanizmadır. CORS, tüm tarayıcılar tarafından uygulanan aynı kaynak politikası için yaygın olarak uygulanan bir çözümdür. Örneğin, tarayıcınızda çalışan JavaScript kodundan Twitter API'sine bir XHR çağrısı yaparsanız çağrı başarısız olur. Bunun nedeni, sayfayı tarayıcınıza sunan alan adının Twitter API'sini sunan alan adıyla aynı olmamasıdır. CORS, merkezler arası kaynak paylaşımı sağlamak isteyen sunucuların "dahil olmasına" izin vererek bu soruna bir çözüm sunar.

API'leri yayınlamadan önce API proxy'lerinize CORS desteği ekleme hakkında bilgi edinmek için API proxy'sine CORS desteği ekleme başlıklı makaleye bakın.

Not: Modern tarayıcıların çoğu CORS'yi zorunlu kılar. Desteklenen tarayıcıların kapsamlı listesini inceleyin. CORS ile ilgili ayrıntılı bir açıklama için Kaynaklar Arası Kaynak Paylaşımı W3C Önerisi'ne bakın.

API'ler sayfasını keşfetme

API'ler sayfasına erişmek için:

1. Yayınla > Portallar'ı ve ardından portalınızı seçin.
2. Portal ana sayfasında API'ler seçeneğini tıklayın.

Alternatif olarak üst gezinme çubuğundaki portal açılır menüsünde de API'ler seçeneğini belirleyebilirsiniz.

API listesi gösterilir.

Önceki şekilde belirtildiği gibi, API'ler sayfasında şunları yapabilirsiniz:

• Portalınızda kullanılabilen API'lerin ayrıntılarını görüntüleyin
• Portalınıza API ekleme
• API referans belgelerini güncellemek için bir API ürünüyle ilişkili OpenAPI Specification'ın anlık görüntüsünü alın
• Portalınızda bir API yayınlama veya yayından kaldırma
• Portalınızdaki bir API'nin kitlesini yönetme
• İlişkili spesifikasyonu düzenleme (Spesifikasyon düzenleyicisini kullanarak spesifikasyon oluşturma konusuna bakın)
• Portalınızdan bir API'yi kaldırma
• İlişkili API ürünü Edge'den kaldırılan "artık" API'leri hızlıca tespit edin ve API ürününü yeniden oluşturun ya da API'yi portalınızdan silin.

Portalınıza API ekleyin

Not: Portalınıza en fazla 100 API ekleyebilirsiniz.

Portalınıza API eklemek için:

1. Yayınla > Portallar'ı ve ardından portalınızı seçin.
2. Portal ana sayfasında API'ler seçeneğini tıklayın.
   Alternatif olarak, üst gezinme çubuğundaki portal açılır menüsünde bulunan API'ler seçeneğini de belirleyebilirsiniz.
3. + API'yi tıklayın.
   API Ürününü Portala Ekle iletişim kutusu görüntülenir.

4. İletişim kutusundaki API Ürünü sekmesinde, portalınıza eklemek istediğiniz API ürününü seçin.
   

5. Sonraki'yi tıklayın.

6. Anlık görüntü için kullanılacak kaynağı seçin.
   API ürününe dahil olan API proxy'sini OpenAPI Specification kullanarak oluşturduysanız açılır listeden spesifikasyonu seçin.
   

   Alternatif olarak şunları da seçebilirsiniz:

   • Spesifikasyon yok. Ardından, Spesifikasyonun anlık görüntüsünü alma bölümünde açıklandığı gibi API yayınlandıktan sonra bir spesifikasyon ekleyin.
   • Yeni spesifikasyon seçmek veya yüklemek için farklı bir spesifikasyon seçin.

7. API'yi portalınıza yayınlamak için Yayınlandı onay kutusunu işaretleyin. API'yi yayınlamaya hazır değilseniz Yayınlandı'nın seçimini kaldırın.
   Bu ayarı daha sonra, Portalınızda bir API'yi yayınlama veya yayından kaldırma bölümünde açıklandığı şekilde değiştirebilirsiniz.

8. Kitle bölümünde, erişime izin vererek API'nizin kitlesini yönetmek için aşağıdaki seçeneklerden birini belirleyin:

   • Anonim kullanıcılar: Tüm kullanıcıların sayfayı görüntüleyebilmesini sağlayın.
   • Sayfayı yalnızca kayıtlı kullanıcıların görüntülemesine izin vermek için kayıtlı kullanıcılar.

   Bu ayarı daha sonra Portalınızdaki bir API için kitleyi yönetme bölümünde açıklandığı şekilde değiştirebilirsiniz.

9. Son'u tıklayın.

Spesifikasyonun anlık görüntüsünü alın

API'nizi yayınladıktan sonra, istediğiniz zaman portalınızda yayınlanan API referans belgelerini güncellemek için OpenAPI Specification'ın yeni bir anlık görüntüsünü alabilirsiniz.

OpenAPI Specification'ın anlık görüntüsünü almak için:

1. Yayınla > Portallar'ı ve ardından portalınızı seçin.
2. Portal ana sayfasında API'ler seçeneğini tıklayın.
   Alternatif olarak, üst gezinme çubuğundaki portal açılır menüsünde bulunan API'ler seçeneğini de belirleyebilirsiniz.
3. İmleci, işlemleri görüntülemek için anlık görüntü almak istediğiniz API'nin üzerine getirin.

4. simgesini tıklayın.

   Not: Anlık görüntünüz seçili olan kaynak spesifikasyonuyla güncelse bir mesaj görüntülenir.

5. Anlık Görüntü Kaynağı açılır listesinden mevcut bir spesifikasyon seçin ya da API dokümanları oluşturmak üzere kullanılacak yeni bir spesifikasyon seçmek veya yüklemek için Farklı bir spesifikasyon seç seçeneğini belirleyin. Alternatif olarak mevcut spesifikasyonu kaldırmak için Spesifikasyon yok'u seçebilirsiniz.

6. Anlık Görüntüyü Güncelle'yi (veya Spesifikasyon Yok seçeneğini belirlediyseniz Anlık Görüntüyü Kaldır'ı) tıklayın.

API referans belgeleri, spesifikasyondan oluşturulur ve API Referansı sayfasına eklenir.

Portalınızda bir API yayınlama veya yayından kaldırma

Bir API'yi portalınızda yayınlamak veya yayından kaldırmak için:

1. Yayınla > Portallar'ı ve ardından portalınızı seçin.
2. Portal ana sayfasında API'ler seçeneğini tıklayın.
   Alternatif olarak, üst gezinme çubuğundaki portal açılır menüsünde bulunan API'ler seçeneğini de belirleyebilirsiniz.
3. İmleci, yayınlamak veya yayından kaldırmak istediğiniz API'nin üzerine getirin.
4. simgesini tıklayın.
5. API'yi portalınızda yayınlamak için Etkin onay kutusunu işaretleyin. API'yi yayından kaldırmak için Etkin'in seçimini kaldırın.
6. Kaydet'i tıklayın.

Portalınızdaki bir API'nin kitlesini yönetme

Şunlara erişim izni vererek portalınızda API'nizin kitlesini yönetin:

• Tüm kullanıcılar
• Yalnızca kayıtlı kullanıcılar

Portalınızdaki bir API'nin kitlesini yönetmek için:

1. Yayınla > Portallar'ı ve ardından portalınızı seçin.
2. Portal ana sayfasında API'ler seçeneğini tıklayın.
   Alternatif olarak, üst gezinme çubuğundaki portal açılır menüsünde bulunan API'ler seçeneğini de belirleyebilirsiniz.
3. İmleci, işlemleri görüntülemek için kitleyi yönetmek istediğiniz API'nin üzerine getirin.
4. simgesini tıklayın.
5. Kitle bölümünün altında aşağıdaki seçeneklerden birini belirleyin:
   • Anonim kullanıcılar: Tüm kullanıcıların API ürününü görüntüleyebilmesini sağlayın.
   • Kayıtlı kullanıcılar (yalnızca kayıtlı kullanıcıların API ürününü görüntüleyebilmesini sağlar).
6. Kaydet'i tıklayın.

Portalınızdan API kaldırma

Bir API'yi portalınızdan kaldırmak için:

1. Yayınla > Portallar'ı ve ardından portalınızı seçin.
2. Portal ana sayfasında API'ler seçeneğini tıklayın.
   Alternatif olarak, üst gezinme çubuğundaki portal açılır menüsünde bulunan API'ler seçeneğini de belirleyebilirsiniz.
3. İşlemler menüsünü görüntülemek için imlecinizi listedeki API'nin üzerine getirin.
4. simgesini tıklayın.

Yayınlanan API'lerinizle ilgili sorunları giderme

Dene özelliğini kullanırken TypeError: Failed to fetch hatası döndürülürse aşağıdaki olası nedenleri ve çözümleri göz önünde bulundurun:

• Karma içerik hataları için bu hata, bilinen bir promosyon kullanıcı arayüzü sorunundan kaynaklanabilir. Olası bir geçici çözüm, OpenAPI Spesifikasyonunuzdaki schemes tanımında HTTP'den önce HTTPS'yi belirttiğinizden emin olmaktır. Örneğin:

   schemes:
     - https
     - http
  

• CORS (kaynaklar arası kaynak paylaşımı) kısıtlama hataları için API proxy'lerinizde CORS'un desteklendiğinden emin olun. CORS, istemci taraflı kaynaklar arası istekleri etkinleştiren standart bir mekanizmadır. API proxy'si için CORS desteği ekleme başlıklı makaleyi inceleyin. CORS'nin tarayıcınızda da etkin olduğundan emin olun.