API'lerinizi yayınlama

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri.
bilgi

Aşağıdaki bölümlerde açıklandığı şekilde, uygulama geliştiricilerin kullanımına sunmak 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 süreçtir:

  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 belgenizin veya GraphQL şemanızın anlık görüntüsünden API referans belgelerini oluşturun. (Anlık görüntüler hakkında daha fazla bilgi için Anlık görüntü nedir? bölümüne bakın.)

Portalda ne yayınlanır?

Bir API yayınladığınızda portalınızda otomatik olarak aşağıdaki güncellemeler yapılır:
  • API referans belgeleri. Sağlanan arayüz, API'nizi OpenAPI belgesi mi yoksa GraphQL şeması mı kullanarak yayınladığınıza bağlıdır. Bkz.:
  • API'ler sayfasına API referans sayfasının bağlantısı eklenir

    API'ler sayfası (örnek portala dahildir), portalınızda yayınlanan tüm API'lerin alfabetik sırayla listelendiği ve daha fazla bilgi için ilgili API referans belgelerinin bağlantılarının yer aldığı bir liste sunar. İsteğe bağlı olarak, aşağıdakileri özelleştirebilirsiniz:

    • Her API kartı için gösterilen resim
    • Geliştiricilerin API'ler sayfasında ilgili API'leri keşfetmesini sağlamak üzere API'leri etiketlemek için kullanılan kategoriler
    ziyaret edin.

    Canlı portalda iki kategori ve resim kullanımını gösteren API sayfası

  • SmartDokümanlar (OpenAPI)

    OpenAPI dokümanı kullanarak bir API yayınladığınızda SmartDokümanlar API referans belgeleri portalınıza eklenir.

    Geliştiriciler, SmartDokümanlar API referans belgelerinizi inceleyip Bu API'yi deneyin panelini kullanarak API isteğinde bulunabilir ve sonucu görüntüleyebilir. Bu API'yi deneyin. OpenAPI belgenizde tanımlanan güvenlik yöntemine göre Temel, API Anahtarı veya OAuth Kimlik Doğrulaması kullanan güvenli olmayan uç noktalar veya güvenli uç noktalarla çalışır. OAuth için şu akışlar desteklenir: yetkilendirme kodu, şifre ve istemci kimlik bilgileri.

    API çağrınızı yetkilendirmeyi, "Bu API'yi deneyin" panelini çıkarmayı, ilgili spesifikasyonları indirmeyi ve API'yi yürütmeyi gösteren açıklama metinlerinin yer aldığı API referans belgeleri sayfası.

    Bu API'yi deneyin panelini genişletmek için simgesini tıklayın. Genişletilmiş panel, curl çağrısı ve kod örneklerini aşağıda gösterildiği gibi HTTP, Python, Node.js gibi çeşitli biçimlerde görüntülemenizi sağlar.

    Genişletilmiş Bu API'yi deneyin paneli

    Grafik QL Gezgini

    GraphQL şeması kullanarak API yayınladığınızda GraphQL Explorer portalınıza eklenir. GraphQL Explorer, API'nize göre sorgu çalıştırmaya yönelik etkileşimli bir oyun alanıdır. Gezgin, GraphQL Foundation tarafından geliştirilen GraphQL IDE'nin referans uygulaması GraphiQL'yi temel alır.

    Geliştiriciler şema tabanlı etkileşimli belgeleri keşfetmek, sorgu oluşturmak ve çalıştırmak, sorgu sonuçlarını görüntülemek ve şemayı indirmek için GraphQL Explorer'ı kullanabilir. Geliştiriciler, API'nize güvenli erişim sağlamak için İstek Başlıkları bölmesinde yetkilendirme üstbilgilerini iletebilir.

    GraphQL hakkında daha fazla bilgi için graphql.org adresine bakın.

    Portalda GraphQL Explorer

    Anlık görüntü nedir?

    Her bir OpenAPI veya GraphQL belgesi, API'nin yaşam döngüsü boyunca bilgi kaynağı işlevi görür. Aynı belge, geliştirmeden yayınlamaya ve izlemeye kadar API yaşam döngüsünün her aşamasında kullanılır. Bir belgede değişiklik yaparken, Bir dokümanı değiştirirsem ne olur? başlıklı makalede açıklandığı gibi, bu değişikliklerin API'niz üzerindeki diğer yaşam döngüsü aşamalarında etkisinin farkında olmanız gerekir.

    API'nizi yayınladığınızda API referans belgelerini oluşturmak için OpenAPI veya GraphQL belgesinin anlık görüntüsünü oluşturursunuz. Bu anlık görüntü, dokümanın belirli bir sürümünü gösterir. Belgede değişiklik yaptığınızda, API referans belgelerindeki son değişiklikleri yansıtmak için belgenin bir anlık görüntüsünü tekrar almaya karar verebilirsiniz.

    Geri çağırma URL'leri hakkında

    OAuth 2.0 yetkilendirme kodu verme türünü (genellikle "üç aşamalı OAuth" olarak adlandırılır) kullanırken örneğin, uygulamalarınız bir geri çağırma URL'si gerektiriyorsa geliştiricilerin uygulamalarını kaydederken bir geri çağırma URL'si belirtmelerini zorunlu kılabilirsiniz. Geri çağırma URL'si genellikle istemci uygulaması adına yetkilendirme kodu almak üzere atanmış bir uygulamanın URL'sini belirtir. Daha fazla bilgi için Yetkilendirme kodu izin türünü uygulama başlıklı makaleyi inceleyin.

    Portalınıza API eklerken uygulama kaydı sırasında geri çağırma URL'sinin zorunlu olup olmayacağını belirleyebilirsiniz. Bu ayarı, API için geri çağırma URL'sini yönetme başlıklı makalede açıklandığı şekilde istediğiniz zaman değiştirebilirsiniz.

    Geliştiriciler bir uygulamayı kaydederken, Uygulamaları kaydetme bölümünde açıklandığı gibi, bu işlemi gerektiren tüm API'ler için bir geri çağırma URL'si girmelidir.

    API proxy'nizi "Bu API'yi deneyin"i destekleyecek şekilde yapılandırma

    API'lerinizi bir OpenAPI belgesi kullanarak yayınlamadan önce, API proxy'nizi SmartDokümanlar API referans dokümanlarındaki Bu API'yi deneyin panelinde istek göndermeyi destekleyecek şekilde aşağıdaki gibi yapılandırmanız gerekir:

    • İstemci taraflı kaynaklar arası istekleri zorunlu kılmak için API proxy'lerinize CORS desteği ekleyin

      CORS, bir web sayfasında yürütülen JavaScript XMLHttpRequest (XHR) çağrılarının kaynak olmayan alanlardan gelen kaynaklarla etkileşim kurmasına olanak tanıyan standart bir mekanizmadır. CORS, "aynı kaynak politikasına" yönelik yaygın olarak uygulanan bir çözümdür tüm tarayıcılarda zorunlu kılınır.

    • Temel kimlik doğrulaması veya OAuth2 kullanıyorsanız API proxy yapılandırmanızı güncelleyin

    Aşağıdaki tabloda, kimlik doğrulama erişimine göre SmartDokümanlar API referans dokümanlarındaki "Bu API'yi deneyin" panelini desteklemek için API proxy'si yapılandırma şartları özetlenmiştir.

    Yetkilendirme erişimi Politika yapılandırma gereksinimleri
    Yok veya API anahtarı API proxy'nize CORS desteği ekleyin. Kolaylık sağlaması açısından, GitHub'da sağlanan örnek CORS çözümünü kullanın veya API proxy'sine CORS desteği ekleme başlıklı makalede açıklanan adımları izleyin.
    Temel kimlik doğrulaması Aşağıdaki adımları uygulayın:
    1. API proxy'nize CORS desteği ekleyin. Kolaylık sağlaması açısından, GitHub'da sağlanan örnek CORS çözümünü kullanın veya API proxy'sine CORS desteği ekleme başlıklı makalede açıklanan adımları izleyin.
    2. CORS Ataması Politikası ekleme politikasında, Access-Control-Allow-Headers üstbilgisinin authorization özelliğini içerdiğinden emin olun. Örneğin:
      <Header name="Access-Control-Allow-Headers">
        origin, x-requested-with, accept, content-type, authorization
      </Header>
    OAuth2
    1. API proxy'nize CORS desteği ekleyin. Kolaylık sağlaması açısından, GitHub'da sağlanan örnek CORS çözümünü kullanın veya API proxy'sine CORS desteği ekleme başlıklı makalede açıklanan adımları izleyin.
    2. CORS Ataması Politikası ekleme politikasında, Access-Control-Allow-Headers üstbilgisinin authorization özelliğini içerdiğinden emin olun. Örneğin:
      <Header name="Access-Control-Allow-Headers">
        origin, x-requested-with, accept, content-type, authorization
      </Header>
    3. OAuth2 politikanızda RFC ile uyumlu olmayan davranışı düzeltin. Kolaylık sağlaması açısından, GitHub'da sağlanan örnek OAuth2 çözümünü kullanın veya aşağıdaki adımları uygulayın:
      • OAuth2 politikasındaki <GrantType> öğesinin, request.formparam.grant_type (form parametresi) olarak ayarlandığından emin olun. Daha fazla bilgi için &lt;GrantType&gt; bölümüne bakın.
      • OAuth2 politikasındaki token_type değerinin, varsayılan BearerToken olarak değil, Bearer olarak ayarlandığından emin olun.

    API kataloğunu keşfedin

    API kataloğunu görüntülemek için: 1. Yayınla > Portallar'ı tıklayın ve portalınızı seçin. 2. Portal ana sayfasında API Catalog'u (API kataloğu) tıklayın. Alternatif olarak, üst gezinme çubuğundaki portal açılır menüsünden API kataloğu'nu seçebilirsiniz.

    API kataloğundaki API'ler sekmesi, portalınıza eklenmiş API'lerin listesini gösterir.

    API&#39;lerle ilgili ad, açıklama, görünürlük, kategoriler, ilişkili spesifikasyon ve değiştirilme zamanı gibi bilgilerin gösterildiği API&#39;ler sekmesi

    Önceki şekilde vurgulanan gibi, API'ler sekmesi şunları yapmanıza olanak tanır:

    Portalınıza API ekleyin

    Portalınıza API eklemek için:

    1. API kataloğuna erişin.
    2. Önceden seçilmemişse API'ler sekmesini tıklayın.
    3. +'yı tıklayın.

      Kataloga bir API ürünü ekleyin iletişim kutusu görüntülenir.

    4. Portalınıza eklemek istediğiniz API ürününü seçin.

    5. İleri'yi tıklayın. API ayrıntıları sayfası görüntülenir.

    6. API referans belgelerinin içeriğini ve bunların portaldaki görünürlüğünü yapılandırın:

      Alan Açıklama
      YayınlandıAPI'yi portalınızda yayınlamak için Yayınlandı'yı seçin. API'yi yayınlamaya hazır değilseniz onay kutusunun işaretini kaldırın. Ayarı daha sonra Portalınızda API yayınlama veya yayından kaldırma başlıklı makalede açıklandığı şekilde değiştirebilirsiniz.
      Başlığı göster Katalogda görüntülenen API'nizin başlığını güncelleyin. Varsayılan olarak API ürün adı kullanılır. Görünen başlığı daha sonra Görünen başlığı ve açıklamayı düzenleme konusunda açıklandığı gibi değiştirebilirsiniz.
      Açıklamayı göster API'nizin katalogda gösterilen açıklamasını güncelleyin. Varsayılan olarak API ürün açıklaması kullanılır. Ekran açıklamasını daha sonra Görünen başlığı ve açıklamayı düzenleme konusunda açıklandığı gibi değiştirebilirsiniz.
      Geliştiricilerin bir geri çağırma URL'si belirtmesini zorunlu kılUygulama geliştiricilerin bir geri çağırma URL'si belirtmesini zorunlu kılmak istiyorsanız etkinleştirin. Geri çağırma URL'sini daha sonra, API için geri çağırma URL'sini yönetme bölümünde açıklandığı şekilde ekleyebilir veya güncelleyebilirsiniz.
      API belgeleri OpenAPI dokümanı kullanmak için:
      1. OpenAPI dokümanı'nı seçin.
      2. Doküman seç'i tıklayın.
      3. Aşağıdaki adımlardan birini uygulayın:
        • Özelliklerim sekmesini tıklayın ve spesifikasyon deposundan bir spesifikasyon seçin.
        • Dosya Yükle sekmesini tıklayıp bir dosya yükleyin.
        • URL'den içe aktar sekmesini tıklayın ve URL'den bir spesifikasyon içe aktarın.
      4. Seç'i tıklayın.

      GraphQL şeması kullanmak için:

      1. GraphQL Schema'yı seçin.
      2. Select Document'ı (Doküman Seç) tıklayın.
      3. GraphQL şemasına gidip seçin.
      4. Seç'i tıklayın.

      Alternatif olarak, Dokümanın anlık görüntüsünü yönetme bölümünde açıklandığı gibi Belge yok'u seçebilir ve API eklendikten sonra bir doküman ekleyebilirsiniz.

      API görünürlüğü

      Kitle yönetimi özelliğinin beta sürümüne kaydolmadıysanız aşağıdaki seçeneklerden birini belirleyin:

      • Anonim kullanıcılar, tüm kullanıcıların API'yi görüntülemesine izin verir.
      • Yalnızca kayıtlı kullanıcıların API'yi görüntülemesine izin vermek için kayıtlı kullanıcılar.

      Kitle yönetimi özelliğinin beta sürümüne kaydolduysanız aşağıdaki seçeneklerden birini belirleyin:

      • Tüm kullanıcıların API'yi görüntülemesine izin vermek için Herkese açık (herkes tarafından görülebilir).
      • Yalnızca kayıtlı kullanıcıların API'yi görüntülemesine izin vermek için kimliği doğrulanmış kullanıcılar.
      • API'yi görüntülemesini istediğiniz belirli kitleleri seçmek için Seçili kitleler.

      Kitle görünürlüğünü daha sonra Portalınızdaki bir API'nin görünürlüğünü yönetme konusunda açıklandığı gibi yönetebilirsiniz.

      Görünen resim API'ler sayfasında API kartında bir resim görüntülemek için Resim seç'i tıklayın. Resim seçin iletişim kutusunda mevcut bir resmi seçin, yeni bir resim yükleyin veya harici bir resmin URL'sini girin ve Seç'i tıklayın. API küçük resmini önizleyin ve Seç'i tıklayın. Resimleri daha sonra ekleyebilirsiniz. Bunun için API kartının resmini yönetme başlıklı makaleye bakın. Harici URL ile resim belirttiğinizde resim, öğelerinize yüklenmez; Ayrıca resmin entegre portala yüklenmesi, içerik güvenliği politikaları tarafından engellenebilen veya kısıtlanabilen kullanılabilirliğine bağlı olacaktır.
      Kategoriler

      Uygulama geliştiricilerin, API'ler sayfasında ilgili API'leri keşfetmesini sağlamak için API'nin etiketleneceği kategorileri ekleyin. Bir kategoriyi tanımlamak için:

      • Açılır listeden bir kategori seçin.
      • Adını yazıp Enter tuşuna basarak yeni bir kategori ekleyin. Yeni kategori Kategoriler sayfasına eklenecek ve diğer API'leri eklerken veya düzenlerken kullanılabilir hale getirilecek.

    7. Kaydet'i tıklayın.

    Dokümanın anlık görüntüsünü yönetme

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

    Dokümanın anlık görüntüsünü yönetmek için:

    1. API kataloğuna erişin.
    2. Önceden seçilmemişse API'ler sekmesini tıklayın.
    3. Düzenlemek istediğiniz API'nin satırını tıklayın.
    4. Anlık görüntü durumunu kontrol edin. Güncel değilse aşağıdaki mesaj görüntülenir: Anlık görüntünün güncel olmadığını gösteren simge ve mesaj.
    5. düzenle simgesi simgesini tıklayın.
    6. Aşağıdaki görevlerden birini gerçekleştirin:
      • Güncel olmayan bir OpenAPI dokümanının anlık görüntüsünü yenilemek için Anlık Görüntüyü Yenile'yi tıklayın.
      • API dokümanlarını oluştururken kullanılan dokümanı değiştirmek için API belgeleri altında Belge Seç'i tıklayın ve yeni dokümanı seçin.
    7. Kaydet'i tıklayın.

    API referans belgeleri, belgeden oluşturulur ve API Referansı sayfasına eklenir. Anlık görüntü durumu güncellendi yeni değer:

    Anlık görüntünün güncel olduğunu gösteren simge ve mesaj

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

    Portalınızda bir API yayınlamak veya yayından kaldırmak için:

    1. API kataloğuna erişin.
    2. Önceden seçilmemişse API'ler sekmesini tıklayın.
    3. Düzenlemek istediğiniz API'nin satırını tıklayın.
    4. Düzenle simgesi simgesini tıklayın.
    5. API ayrıntıları altında, API'yi portalınızda yayınlamak veya yayından kaldırmak için Yayınlandı (katalogda listelenir) seçeneğini belirleyin veya bu seçeneğin işaretini kaldırın.
    6. Kaydet'i tıklayın.

    Portalınızdaki bir API'nin görünürlüğünü yönetme

    Şunlara erişim izni vererek portalınızdaki bir API'nin görünürlüğünü yönetin:

    ziyaret edin.

    Portalınızdaki bir API'nin görünürlüğünü yönetmek için:

    1. API kataloğuna erişin.
    2. Önceden seçilmemişse API'ler sekmesini tıklayın.
    3. Düzenlemek istediğiniz API'nin satırını tıklayın.
    4. Düzenle simgesi simgesini tıklayın.
    5. API görünürlüğü altında aşağıdaki seçeneklerden birini belirleyin:
    6. Görünürlük ayarını seçin. Kitleler özelliğinin beta sürümüne kaydolduysanız aşağıdaki seçeneklerden birini belirleyin:

      • Tüm kullanıcıların sayfayı görüntüleyebilmesini sağlamak için Herkese açık (herkes tarafından görülebilir).
      • Yalnızca kayıtlı kullanıcıların sayfayı görüntüleyebilmesini sağlamak için kimliği doğrulanmış kullanıcılar.
      • Sayfayı görüntüleyebilmesini istediğiniz belirli kitleleri seçmek için Seçili kitleler. Portalınızın kitlelerini yönetme konusuna bakın.
      ziyaret edin. Aksi durumda, aşağıdaki seçeneklerden birini belirleyin:
      • Tüm kullanıcıların sayfayı görüntülemesine izin vermek için Anonim kullanıcılar.
      • Yalnızca kayıtlı kullanıcıların sayfayı görüntülemesine izin vermek için kayıtlı kullanıcılar.

    7. Gönder'i tıklayın.

    Bir API için geri çağırma URL'sini yönetme

    Bir API'nin geri çağırma URL'sini yönetin. Geri çağırma URL'leri hakkında başlıklı makaleyi inceleyin.

    Bir API'nin geri çağırma URL'sini yönetmek için:

    1. API kataloğuna erişin.
    2. Önceden seçilmemişse API'ler sekmesini tıklayın.
    3. Düzenlemek istediğiniz API'nin satırını tıklayın.
    4. Düzenle simgesi simgesini tıklayın.
    5. API ayrıntıları altında, API'yi portalınızda yayınlamak veya yayından kaldırmak için Yayınlandı (katalogda listelenir) seçeneğini belirleyin veya seçimi kaldırın.
    6. Kaydet'i tıklayın.

    API kartının resmini yönetme

    Geçerli resmi ekleyerek veya değiştirerek API'ler sayfasında API kartıyla görünen resmi yönetin.

    Bir API kartının resmini yönetmek için:

    1. API kataloğuna erişin.
    2. Önceden seçilmemişse API'ler sekmesini tıklayın.
    3. Düzenlemek istediğiniz API'nin satırını tıklayın.
    4. Düzenle simgesi simgesini tıklayın.
    5. API ayrıntıları altında:

      • Resim belirtmek veya seçili olmayan bir resim yüklemek için Resim seç'i tıklayın.
      • Farklı bir resim belirtmek veya yüklemek için Resmi değiştir'i tıklayın.
      • Resmi kaldırmak için resimdeki x işaretini tıklayın.

      Bir resim belirtirken, kullanılan harici URL'ye sahip bir resmi belirtin katalog öğesi veya katalog öğesinin dosya yolu resim dosyalarını içerebilir (örneğin, /files/book-tree.jpg). Harici bir resmin URL'si belirtilirken, resim öğelerinize yüklenmelidir. Ayrıca resmin entegre edilmiş tarafından engellenebilir veya kısıtlanabilir, ancak bu siteler içerik güvenliği politikaları hakkında daha fazla bilgi edinin.

    6. Kaydet'i tıklayın.

    Kategorileri kullanarak API etiketleme

    Aşağıdaki yöntemlerden birini kullanarak kategorileri kullanarak API'leri etiketleyin:

    • API'yi düzenlerken API'lerin etiketlendiği kategorileri aşağıda açıklandığı şekilde yönetin.
    • Kategoriyi düzenlerken bir kategoriyle etiketlenen API'leri yönetin.

    API'yi düzenlerken bir API'yi kategoriler halinde etiketlemek için:

    1. API kataloğuna erişin.
    2. Önceden seçilmemişse API'ler sekmesini tıklayın.
    3. Düzenlemek istediğiniz API'nin satırını tıklayın.
    4. Düzenle simgesi simgesini tıklayın.
    5. Kategoriler alanını tıklayın ve aşağıdaki adımlardan birini uygulayın:
      • Açılır listeden bir kategori seçin.
      • Adını yazıp Enter tuşuna basarak yeni bir kategori ekleyin. Yeni kategori Kategoriler sayfasına eklenecek ve diğer API'leri eklerken veya düzenlerken kullanılabilir hale getirilecek.
    6. API'yi daha fazla kategoride etiketlemek için bu işlemi tekrarlayın.
    7. Kaydet'i tıklayın.

    Görünen başlığı ve açıklamayı düzenleyin

    Görünen başlığı ve açıklamayı düzenlemek için:

    1. API kataloğuna erişin.
    2. Önceden seçilmemişse API'ler sekmesini tıklayın.
    3. Düzenlemek istediğiniz API'nin satırını tıklayın.
    4. Düzenle simgesi simgesini tıklayın.
    5. Görünen başlık ve Görüntüleme açıklaması alanlarını gerektiği gibi düzenleyin.
    6. Kaydet'i tıklayın.

    Portalınızdan API kaldırma

    Portalınızdan bir API'yi kaldırmak için:

    1. API kataloğuna erişin.
    2. Önceden seçilmemişse API'leri seçin.
    3. İşlemler menüsünü görüntülemek için imlecinizi listede API'nin üzerine getirin.
    4. Düzenle simgesi simgesini tıklayın.

    İlgili API'leri keşfetmek için kullanılan kategorileri yönetin

    Uygulama geliştiricilerin, canlı portalın API sayfasında ilgili API'leri keşfetmesini sağlamak için kategorileri kullanarak API'leri etiketleyin. Aşağıdaki bölümlerde açıklandığı şekilde, kategori ekleyin ve kategorileri yönetin.

    Kategoriler sayfasını keşfetme

    Kategoriler sayfasını görüntülemek için:

    1. Yayınla > Portallar'ı tıklayın ve portalınızı seçin.
    2. Portal ana sayfasında API Catalog'u (API kataloğu) tıklayın.

      Alternatif olarak, üst gezinme çubuğundaki portal açılır menüsünden API kataloğu'nu seçebilirsiniz.

    3. Kategoriler sekmesini tıklayın.

    API kataloğundaki Kategoriler sekmesi, portalınız için tanımlanmış kategorilerin listesini görüntüler.

    Kategori adını, atanan API&#39;lerin adlarını ve toplam sayısını gösteren Kategoriler sekmesi

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

    Kategori ekleme

    Aşağıdaki yöntemlerden birini kullanarak kategori ekleyin:

    • Portala API eklerken kategori adı girin
    • Aşağıda açıklandığı şekilde manuel olarak kategori ekleyin

    Yeni kategori Kategoriler sayfasına eklenecek ve diğer API'leri eklerken veya düzenlerken kullanılabilir hale getirilecek.

    Manuel olarak kategori eklemek için:

    1. Kategoriler sayfasına erişin.
    2. +'yı tıklayın.
    3. Yeni kategorinizin adını girin.
    4. İsteğe bağlı olarak, kategoriyle etiketlenecek bir veya daha fazla API seçin.
    5. Oluştur'u tıklayın.

    Kategori düzenleme

    Bir kategoriyi düzenlemek için:

    1. Kategoriler sayfasına erişin.
    2. simgesini tıklayın.
    3. Kategorinin adını düzenleyin.
    4. API etiketleri ekleyin veya kaldırın.
    5. Kaydet'i tıklayın.

    Kategori silme

    Bir kategoriyi sildiğinizde, o kategoriye ait tüm API etiketleri de silinir.

    Bir kategoriyi silmek için:

    1. Kategoriler sayfasına erişin.
    2. İşlemler menüsünü görüntülemek için imlecinizi düzenlemek istediğiniz kategorinin üzerine getirin.
    3. simgesini tıklayın.
    4. Kategorinin adını düzenleyin.
    5. API ekleyin veya kaldırın.
    6. Kaydet'i tıklayın.

    Yayınlanan API'lerinizle ilgili sorunları giderme

    Aşağıdaki bölümlerde, yayınlanan API'lerimizle ilgili belirli hataları gidermenize yardımcı olacak bilgiler sağlanmaktadır.

    Hata: "Bu API'yi deneyin" kullanılırken hata döndürülemedi

    Bu API'yi 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ında, hata bilinen bir swagger-ui sorunundan kaynaklanıyor olabilir. Olası geçici bir çözüm, OpenAPI dokümanınızdaki schemes tanımında HTTP'den önce HTTPS'yi belirttiğinizden emin olmaktır. Örneğin:

      schemes:
         - https
         - http
      
    • Kaynaklar Arası Kaynak Paylaşımı (CORS) kısıtlama hataları için CORS'nin API proxy'lerinizde desteklendiğinden emin olun. CORS, istemci taraflı kaynaklar arası isteklere olanak tanıyan standart bir mekanizmadır. API proxy'nizi "Bu API'yi deneyin" özelliğini destekleyecek şekilde yapılandırma başlıklı makaleye göz atın.

    Hata: 'Access-Control-Allow-Origin' başlıkta birden çok değer '*, *' var, ancak yalnızca bir tanesine izin veriliyor

    "Bu API'yi deneyin" seçeneğini kullanırken Access-Control-Allow-Origin üstbilgisi zaten mevcutsa aşağıdaki hata mesajını alabilirsiniz:

    The 'Access-Control-Allow-Origin' header contains multiple values '*, *', but only one is allowed.

    Bu hatayı düzeltmek içinassignMessage politikasını, aşağıdaki alıntıda gösterildiği gibi, <Add> yerine CORS başlıklarını ayarlamak için <Set> kullanacak şekilde değiştirin. Daha fazla bilgi için ilgili topluluk makalesini inceleyin.

    <AssignMessage async="false" continueOnError="false" enabled="true" name="add-cors">
        <DisplayName>Add CORS</DisplayName>
        <FaultRules/>
        <Properties/>
        <Set>
            <Headers>
                <Header name="Access-Control-Allow-Origin">{request.header.origin}</Header>
                <Header name="Access-Control-Allow-Headers">origin, x-requested-with, accept, content-type, authorization</Header>
                <Header name="Access-Control-Max-Age">3628800</Header>
                <Header name="Access-Control-Allow-Methods">GET, PUT, POST, DELETE</Header>
            </Headers>
        </Set>
        <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
        <AssignTo createNew="false" transport="http" type="response"/>
    </AssignMessage>
    

    Hata: İstek başlığı alanına izin verilmiyor

    Bu API'yi kullanırken aşağıdaki örneğe benzer bir Request header field not allowed hatası alırsanız CORS politikasında desteklenen başlıkları güncellemeniz gerekebilir. Örneğin:

    Access to XMLHttpRequest ... has been blocked by CORS policy: Request header field
    content-type is not allowed by Access-Control-Allow-Headers in preflight response
    

    Bu örnekte, content-type üstbilgisini aşağıdaki bölümde açıklandığı gibi CORS işlemlerinin atamasındaki Access-Control-Allow-Headers bölümüne eklemeniz gerekir: Yeni bir API proxy'sine CORS ekleme politikası ekleme.

    Hata: OAuth2 kullanarak API proxy'si çağrılırken erişim reddedildi

    Apigee'nin OAuthV2 politikası, RFC ile uyumlu olmayan belirli özellikleri içeren bir jeton yanıtı döndürür. Örneğin politika, RFC ile uyumlu olması beklenen Bearer değeri yerine BearerToken değerine sahip bir jeton döndürür. Bu geçersiz token_type yanıtı, Deneme Bu API'yi kullanırken Access denied hatasına neden olabilir.

    Bu sorunu düzeltmek için politika çıkışını uyumlu bir biçime dönüştürmek üzere JavaScript veya QueryMessage politikası oluşturabilirsiniz. Daha fazla bilgi için bkz. RFC ile uyumlu olmayan bir davranışa sahip olması gerekir.