6. Adım: Bir API yayınlayın

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

Bu adımda, aşağıdaki adımları uygulayarak bir API'yi portala yayınlayacaksınız:
1. OpenAPI spesifikasyonu oluşturun
2. Spesifikasyondan API proxy'si oluşturma
3. API ürünü oluşturun
4. API'yi portalınızda yayınlama

1. adım: OpenAPI Specification oluşturun

Her OpenAPI spesifikasyonu, API yaşam döngüsü boyunca doğruluğun kaynağı olarak işlev görür. Geliştirmeden yayınlamaya kadar API yaşam döngüsünün her aşamasında aynı spesifikasyon kullanılır.

OpenAPI Specification oluşturmak için:

  1. Spesifikasyonlar sayfasını açmak için soldaki gezinme çubuğunda Geliştir > Spesifikasyonlar'ı seçin.
  2. + Spec > Import URL'yi (URL'yi İçe Aktar) tıklayın.
  3. İçe aktarma iletişim kutusuna aşağıdaki bilgileri girin:
  4. İçe aktarma adı: helloworld
  5. Import Url: https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml

  6. İçe Aktar'ı tıklayın.

2. adım: Spesifikasyondan API proxy'si oluşturma

API'yi açıklayan bir OpenAPI Specification'dan API proxy'si oluşturun.

OpenAPI Specification'dan API proxy'si oluşturmak için:

  1. İşlemler menüsünü görüntülemek için imlecinizi Özellikler sayfasındaki helloworld özelliğinin üzerine getirin.
  2. Spesifikasyondan API proxy'si oluşturmak için simgesini tıklayın.
    Proxy Oluşturma sihirbazı açılır ve Ayrıntılar sayfası, OpenAPI Specification'daki değerler kullanılarak önceden doldurulur.
  3. Açıklama alanını aşağıdaki gibi düzenleyin: Hello world için API proxy'si.
  4. İleri'yi tıklayın.
  5. Politikalar sayfasında:

    • Security: Authorization (Güvenlik: Yetkilendirme) bölümünde Pass through (no authorization) [Geçiş (yetkilendirme yok)] seçeneğini belirleyin.
    • Güvenlik: Tarayıcı bölümünde CORS başlıkları ekle'yi seçin .

    Geçiş ve CORS başlıkları ekle seçeneklerinin belirlendiği, Proxy Oluşturma sihirbazındaki ortak politikalar sayfası

  6. İleri'yi tıklayın.

  7. Akışlar sayfasında tüm işlemlerin seçili olduğundan emin olun ve Sonraki'yi tıklayın.
    Proxy akışları oluşturma

  8. Sanal Ana Makineler sayfasında tüm sanal ana makinelerin seçili olduğundan emin olun ve Sonraki'yi tıklayın.

  9. Özet sayfasında, İsteğe Bağlı Dağıtım bölümünde dağıtmak istediğiniz ortamı seçin.

  10. Oluştur'u tıklayın.

Özet sayfasında, yeni API proxy'nizin başarıyla oluşturulduğunu ve test ortamınıza dağıtıldığını belirten bir onay mesajı görürsünüz.

3. adım: API ürünü oluşturma

API tüketicilerinize sunmak istediğiniz API kaynaklarını içeren bir API ürünü oluşturun.

API ürünü oluşturmak için:

  1. API Ürünleri sayfasını açmak için soldaki gezinme çubuğunda Yayınla > API Ürünleri'ni seçin.
  2. + API Ürünü'nü tıklayın.
    Yeni Ürün sayfası görüntülenir.
  3. API ürününüz için Ürün Ayrıntıları'nı girin.
    Not: API ürününü yayınladığınızda, Görünen Ad ve Açıklama alanları varsayılan olarak portalda gösterilir. 4. adım: API'yi portalınızda yayınlayın bölümündeki değerleri düzenleyebilirsiniz.
    Alan Değer
    Ad Hello World
    Görünen Ad Hello World
    Açıklama Basit "Merhaba Dünya" örneği
    Ortam API proxy'sinin dağıtıldığı ortamı seçin.
    Erişim Herkese açık
    Erişim isteklerini otomatik olarak onaylama Etkin
    Kota (boş bırakın)
    İzin verilen OAuth kapsamları (boş bırakın)
  4. API kaynakları bölümünde, API ürününüze eklenecek API proxy'lerini belirlemek için Proxy ekle'yi tıklayın.
    API Kaynağı Ekle iletişim kutusu gösterilir.
  5. API Proxy'yi (önceden seçilmemişse) tıklayın ve listeden Mock-Target-API'yi seçin.
  6. Ekle'yi tıklayın.
  7. API ürününü kaydetmek için Kaydet'i tıklayın.

    Tüm alanları ayarlanmış olarak gösteren Hello World API ürünü

4. adım: API'yi portalınızda yayınlayın

Müşterilerinizin API hakkında bilgi edinmesini ve API'yi kullanmasını sağlamak için API'yi portalınızda yayınlayın.

API'yi portalınızda yayınlamak için:

  1. Portalınızda API'ler sayfasına gidin:
    1. Soldaki gezinme çubuğunda Yayınla > Portallar'ı seçin.
    2. Portalı açmak için İlk portalım satırını tıklayın.
    3. API'ler sayfasını görüntülemek için API kataloğu'nu tıklayın.
  2. +'yı tıklayın.
  3. Add an API product to the catalog (Kataloga bir API ürünü ekle) iletişim kutusunda Hello World'ü seçin ve Next'i (Sonraki) tıklayın.
  4. API ayrıntıları bölümünde aşağıdaki seçenekleri yapılandırın:
    • API'yi portalınızda yayınlamak için Yayınlandı (katalogda listelenir) seçeneğini belirleyin.
    • Görünen resim için:
      1. Resim seçin'i tıklayın.
      2. Resim seç iletişim kutusundaki mevcut resimler listesinden home-background.jpg dosyasını tıklayın.
      3. Seç'i tıklayın.
      4. Resmi önizleyin ve Seç'i tıklayın.
    • Kategoriler için Başlayın yazıp Enter tuşuna basın.

    Diğer tüm değerleri varsayılan ayarlarında bırakın.

  5. API belgeleri bölümünde, OpenAPI spesifikasyonunuzun anlık görüntüsünden API referans belgelerini otomatik olarak oluşturmak için:
    1. OpenAPI belgesi'ni seçin.
    2. Belge Seç'i tıklayın.
    3. Özelliklerim sekmesini seçin (daha önce seçilmemişse).
    4. Özellikler listesinden helloworld'ü seçin.
    5. Seç'i tıklayın.
  6. API ayrıntılarını kaydetmek için Kaydet'i tıklayın.

    Tüm alanların ayarlandığını gösteren Hello World API'si

API referans belgelerini görüntülemek için:

  1. Değişiklikleri canlı portalda görüntülemek için Canlı Portal'ı tıklayın (veya canlı portal başka bir sekmede zaten açıksa canlı portalı yenileyin).
  2. Yayınlanan API'yi görüntülemek için üst gezinme çubuğunda API'ler'i tıklayın.
  3. API referans belgelerini görüntülemek için Hello World (Merhaba Dünya) kartını tıklayın. API'nizi deneyin.

Try this API (Bu API'yi deneyin) paneliyle yayınlanan sahte hedef API


Tebrikler! Eğitimi başarıyla tamamladınız. Daha fazla bilgi edinmeye hazır mısınız? Entegre portalınızı oluşturma sayfasına gidin.