API'lerinizi yayınlama

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 belgenizin veya GraphQL şemanızın anlık görüntüsünden API referans dokümanları 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 neler yayınlanır?

Bir API yayınladığınızda aşağıdaki güncellemeler portalınıza otomatik olarak yapılır:
  • API referans dokümanları. Sağlanan arayüz, API'nizi OpenAPI belgesi veya GraphQL şeması kullanarak yayınlayıp yayınlamadığınıza bağlıdır. Aşağıdakileri inceleyin:
  • API'ler sayfasına API referans sayfasının bir bağlantısı eklenir

    API'ler sayfasında (örnek portala dahildir) portalınızda yayınlanan tüm API'lerin listesi alfabetik sırayla, daha fazla bilgi için ilgili API referans dokümanlarının bağlantılarıyla birlikte sunulur. İsteğe bağlı olarak aşağıdakileri özelleştirebilirsiniz:

    • Her API kartı için gösterilen resim
    • Geliştiricilerin API'ler sayfasındaki ilgili API'leri keşfetmesini sağlamak amacıyla API'leri etiketlemek için kullanılan kategoriler

    Canlı portalda iki kategoriyi ve resim kullanımını gösteren API'ler sayfası

  • SmartDokümanlar (OpenAPI)

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

    Geliştiriciler, SmartDokümanlar API referans belgelerinizi inceleyebilir ve API isteğinde bulunmak ve sonucu görüntülemek için Bu API'yi deneyin panelini kullanabilir. Bu API'yi deneyin. OpenAPI belgenizde tanımlanan güvenlik yöntemine bağlı olarak, Temel, API Anahtarı veya OAuth Kimlik Doğrulaması kullanan güvenli olmayan uç noktalarla 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 spesifikasyonu indirmeyi ve API'yi yürütmeyi gösteren açıklama metinlerini içeren API referans belgeleri sayfası.

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

    Bu API'yi deneyin paneli genişletildi

    GraphQL Kaşifi

    GraphQL şeması kullanarak API yayınladığınızda GraphQL Gezgini, portalınıza eklenir. GraphQL Explorer, API'nize karşı sorgu çalıştırabileceğiniz etkileşimli bir oyun alanıdır. Gezgin, GraphQL Foundation tarafından geliştirilen GraphQL IDE'nin referans uygulaması olan GraphiQL'i temel alır.

    Geliştiriciler, şema tabanlı etkileşimli belgeleri incelemek, sorgu oluşturup çalıştırmak, sorgu sonuçlarını görüntülemek ve şemayı indirmek için GraphQL Gezgini'ni kullanabilir. Geliştiriciler, API'nize erişimi güvenli hale getirmek için İstek Başlıkları bölmesinde yetkilendirme üst bilgilerini iletebilir.

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

    Portalda GraphQL Explorer

    Anlık görüntü nedir?

    Her OpenAPI veya GraphQL belgesi, bir API'nin yaşam döngüsü boyunca doğru bilgi kaynağı işlevi görür. API yaşam döngüsünün, geliştirmeden yayınlamaya ve izlemeye kadar her aşamasında aynı belge kullanılır. Bir dokümanda değişiklik yaparken, Bir belgeyi değiştirirsem ne olur? bölümünde açıklandığı gibi, 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ü alırsınız. Bu anlık görüntü, dokümanın belirli bir sürümünü temsil eder. Belgeyi değiştirirseniz API referans belgelerindeki en son değişiklikleri yansıtmak için belgenin başka bir anlık görüntüsünü almaya karar verebilirsiniz.

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

    OAuth 2.0 yetkilendirme kodu izin türü (genellikle "üç aşamalı OAuth" olarak anılır) kullanılırken olduğu gibi uygulamalarınız bir geri çağırma URL'si gerektiriyorsa geliştiricilerin uygulamalarını kaydederken bir geri arama 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 bölümüne bakın.

    Portalınıza bir API eklerken uygulama kaydı sırasında geri çağırma URL'sinin zorunlu olup olmayacağını yapılandırabilirsiniz. Bu ayarı istediğiniz zaman Bir API'nin geri çağırma URL'sini yönetme bölümünde açıklandığı şekilde değiştirebilirsiniz.

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

    API proxy'nizi "Bu API'yi deneyin" işlevini destekleyecek şekilde yapılandırın

    API'lerinizi bir OpenAPI belgesi kullanarak yayınlamadan önce, SmartDokümanlar API referans dokümanlarındaki Experiment this API (Bu API'yi deneyin) panelinde, istekte bulunmayı desteklemek için API proxy'nizi 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 alanlardaki kaynaklarla etkileşim kurmasına olanak tanıyan standart bir mekanizmadır. CORS, tüm tarayıcılar tarafından zorunlu kılınan "aynı kaynak politikası" için yaygın olarak uygulanan bir çözümdür.

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

    Aşağıdaki tabloda, kimlik doğrulama erişimine bağlı olarak SmartDokümanlar API referans belgelerindeki "Bu API'yi deneyin" panelini desteklemek için gereken API proxy'si yapılandırma şartları özetlenmektedir.

    Yetkilendirme erişimi Politika yapılandırma şartları
    Yok veya API anahtarı API proxy'nize CORS desteği ekleyin. Size kolaylık sağlaması için, 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ı uygulayın.
    Temel kimlik doğrulaması Aşağıdaki adımları uygulayın:
    1. API proxy'nize CORS desteği ekleyin. Size kolaylık sağlaması için, 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ı uygulayın.
    2. Add CORSassignMessage 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. Size kolaylık sağlaması için, 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ı uygulayın.
    2. Add CORSassignMessage 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. Size kolaylık sağlaması için 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 <GrantType> bölümünden ulaşabilirsiniz.
      • OAuth2 politikasındaki token_type değerinin varsayılan BearerToken yerine Bearer değerine ayarlandığından emin olun.

    API kataloğunu keşfedin

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

    API kataloğundaki API'ler sekmesinde, portalınıza eklenen API'lerin listesi gösterilir.

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

    Önceki şekilde vurgulandığı 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şme.
    2. Seçili değilse API'ler sekmesini tıklayın.
    3. +'yı tıklayın.

      Kataloğa 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. Sonraki'yi tıklayın.
      API ayrıntıları sayfası görüntülenir.

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

      Alan Açıklama
      Yayınlanma tarihiAPI'yi portalınıza yayınlamak için Yayınlandı'yı seçin. API'yi yayınlamaya hazır değilseniz onay kutusunun işaretini 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ığı gibi 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 bölümünde açıklandığı gibi değiştirebilirsiniz.
      Görüntüleme açıklaması Katalogda gösterilen API'nizin 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 bölümünde açıklandığı gibi değiştirebilirsiniz.
      Geliştiricilerin geri çağırma URL'si belirtmelerini zorunlu kılUygulama geliştiricilerin bir geri çağırma URL'si belirtmelerini zorunlu kılmak istiyorsanız etkinleştirin. Geri çağırma URL'sini daha sonra Bir API'nin 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:
        • Spesifikasyonlarım sekmesini tıklayın ve spesifikasyon mağazasından bir spesifikasyon seçin.
        • Dosya Yükle sekmesini tıklayın ve bir dosya yükleyin.
        • URL'den içe aktar sekmesini tıklayın ve bir URL'den spesifikasyon içe aktarın.
      4. Select'i (Seç) tıklayın.

      GraphQL şeması kullanmak için:

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

      Alternatif olarak Belge yok'u seçebilir ve API eklendikten sonra, Belgenin anlık görüntüsünü yönetme bölümünde açıklandığı şekilde 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 verin.
      • 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:

      • Herkese açık (herkese görünür): Tüm kullanıcıların API'yi görüntülemesine izin verin.
      • 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 ayarını kullanın.
      • API'yi görüntüleyebilmesini 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 bölümünde açıklandığı şekilde 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ç iletişim kutusunda, mevcut bir resmi seçin, yeni bir resim yükleyin veya harici bir resmin URL'sini girip Seç'i tıklayın. API küçük resmini önizleyin ve Seç'i tıklayın. Daha sonra bir resim ekleyebilirsiniz (API kartının resmini yönetme bölümünde açıklandığı gibi).
      Kategoriler

      Uygulama geliştiricilerin, API'ler sayfasındaki 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.
      • Yeni bir kategori eklemek için ilgili kategorinin adını yazıp Enter'a basın. Yeni kategori, Kategoriler sayfasına eklenir ve başka API'ler eklenirken veya düzenlenirken kullanılabilir hale gelir.

    7. Kaydet'i tıklayın.

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

    API'nizi yayınladıktan sonra, portalınızda yayınlanan API referans dokümanını güncellemek için istediğiniz zaman 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şme.
    2. Seçili değilse 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österilir:
      Anlık görüntünün eski olduğunu belirten simge ve mesaj
    5. düzenle simgesi simgesini tıklayın.
    6. Aşağıdaki görevlerden birini gerçekleştirin:
      • Eski 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şturmak üzere kullanılan dokümanı değiştirmek için API dokümanları 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üncel olarak güncellenir:

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

    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. API kataloğuna erişme.
    2. Seçili değilse 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ı bölümünde, sırasıyla API'yi portalınızda yayınlamak veya yayından kaldırmak için Yayınlandı (katalogda listelenir) seçeneğini belirleyin veya seçimini kaldırın.
    6. Kaydet'i tıklayın.

    Bir API'nin portalınızdaki görünürlüğünü yönetme

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

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

    1. API kataloğuna erişme.
    2. Seçili değilse 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üğü bölümünde 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üleyebilmesi için Herkese açık (herkes tarafından görülebilir).
      • Sayfayı yalnızca kayıtlı kullanıcıların görüntülemesine izin vermek için kimliği doğrulanmış kullanıcılar'ı seçin.
      • Sayfayı görüntüleyebilmesini istediğiniz belirli kitleleri seçmek için Seçili kitleler. Portalınızın kitlelerini yönetme başlıklı makaleyi inceleyin.
      Dilerseniz aşağıdaki seçeneklerden birini de belirleyebilirsiniz:
      • 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.

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

    Bir API'nin 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şme.
    2. Seçili değilse 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ı bölümünde, sırasıyla API'yi portalınızda yayınlamak veya yayından kaldırmak için Yayınlandı (katalogda listelenir) seçeneğini belirleyin veya seçimini kaldırın.
    6. Kaydet'i tıklayın.

    Bir API kartının resmini yönetme

    API'ler sayfasında API kartıyla görünen resmi eklemek veya mevcut resmi değiştirerek yönetin.

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

    1. API kataloğuna erişme.
    2. Seçili değilse 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ı bölümünde:

      • Seçili bir resim yoksa resim seçmek veya yüklemek için Resim seç'i tıklayın.
      • Farklı bir resim seçmek veya yüklemek için Resmi değiştir'i tıklayın.
      • Kaldırmak için resimdeki x simgesini tıklayın.
    6. Kaydet'i tıklayın.

    Kategorileri kullanarak API'leri etiketleme

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

    • Bir API'yi düzenlerken API'nin etiketlendiği kategorileri aşağıda açıklandığı gibi yönetin.
    • Kategoriyi düzenlerken bir kategoride etiketlenen API'leri yönetin.

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

    1. API kataloğuna erişme.
    2. Seçili değilse 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.
      • Yeni bir kategori eklemek için ilgili kategorinin adını yazıp Enter'a basın. Yeni kategori, Kategoriler sayfasına eklenir ve başka API'ler eklenirken veya düzenlenirken kullanılabilir hale gelir.
    6. API'yi daha fazla kategoriye etiketlemek için bu işlemi tekrarlayın.
    7. Kaydet'i tıklayın.

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

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

    1. API kataloğuna erişme.
    2. Seçili değilse 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ünen açıklama alanlarını gerektiği gibi düzenleyin.
    6. Kaydet'i tıklayın.

    Portalınızdan API kaldırma

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

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

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

    Uygulama geliştiricilerin, canlı portalın API'ler sayfasında ilgili API'leri keşfetmesini sağlamak için kategorileri kullanarak bir API'yi etiketleyebilirsiniz. Kategorileri aşağıdaki bölümlerde açıklandığı gibi ekleyin ve yönetin.

    Kategoriler sayfasını keşfetme

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

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

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

    3. Kategoriler sekmesini tıklayın.

    API kataloğundaki Kategoriler sekmesinde, portalınız için tanımlanmış kategorilerin listesi görüntülenir.

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

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

    Kategori ekleme

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

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

    Yeni kategori, Kategoriler sayfasına eklenir ve başka API'ler eklenirken veya düzenlenirken kullanılabilir hale gelir.

    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, kategoriye göre etiketlemek için bir veya daha fazla API seçin.
    5. Create'i (Oluştur) 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, ilgili kategorideki 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'lerimizdeki belirli hataları gidermenize yardımcı olacak bilgiler verilmektedir.

    Hata: Bu API 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ı için bu hata, bilinen bir promosyon kullanıcı arayüzü sorunundan kaynaklanabilir. Olası bir geçici çözüm, OpenAPI belgenizdeki schemes tanımında HTTP'den önce HTTPS'yi belirttiğinizden emin olmaktır. Örneğin:

      schemes:
         - https
         - http
      
    • Çapraz kaynak paylaşımı (CORS) 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'nizi bu API'yi destekleyecek şekilde yapılandırma başlıklı makaleyi inceleyin.

    Hata: "Access-Control-Allow-Origin" başlığı birden çok "*, *" değeri içeriyor ancak yalnızca birine izin veriliyor

    Experiment this API'yi kullanırken Access-Control-Allow-Origin üstbilgisi zaten varsa 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çin, aşağıdaki alıntıda gösterildiği gibi AttributionMessage politikasını değiştirerek <Add> yerine CORS başlıklarını ayarlamak için <Set> politikasını kullanın. Daha fazla bilgi edinmek 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, Yeni bir API proxy'sine CORS politikası ekleme bölümünde açıklandığı gibi, CORS başarma politikanızdaki Access-Control-Allow-Headers bölümüne content-type başlığını eklemeniz gerekir.

    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üyor. Örneğin politika, beklenen RFC uyumlu Bearer değeri yerine BearerToken değerini içeren bir jeton döndürür. Bu geçersiz token_type yanıtı, 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 bir JavaScript veya AtMessage politikası oluşturabilirsiniz. Daha fazla bilgi edinmek için RFC ile uyumlu olmayan davranış bölümüne bakın.