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 kullanabilmesi için API'leri portalınızda yayınlayın.

API yayınlamaya genel bakış

API'leri portalınızda yayınlama süreci iki adımdan oluşur:

  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 belgenizden veya GraphQL şemanızdan Render API referans belgeleri oluşturun. (Anlık görüntüler hakkında daha fazla bilgi için Anlık görüntü nedir? başlıklı makaleyi inceleyin.)

Portala neler yayınlanır?

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

  • API referans belgeleri Sağlanan arayüz, API'nizi OpenAPI belgesi veya GraphQL şeması kullanarak yayınlayıp yayınlamadığınıza bağlıdır. Şu sayfalara göz atın:
  • API referans sayfasının bağlantısı, API'ler sayfasına eklenir

    API'ler sayfası ( örnek portal ile birlikte verilir), portalınızda yayınlanan tüm API'lerin alfabetik sırayla listelendiği bir liste sunar. Daha fazla bilgi için ilgili API referans belgelerine bağlantılar da içerir. İ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 için API'leri etiketlemek üzere kullanılan kategoriler

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

SmartDocs (OpenAPI)

OpenAPI belgesi kullanarak bir API yayınladığınızda SmartDocs API referans belgeleri portalınıza eklenir.

Geliştiriciler, SmartDocs API referans belgelerinizi inceleyebilir ve Try this API (Bu API'yi deneyin) panelini kullanarak API isteğinde bulunup çıkışı görüntüleyebilir. Bu API'yi deneyin, OpenAPI belgenizde tanımlanan güvenlik yöntemine bağlı olarak, güvenli olmayan uç noktalarla veya Temel, API Anahtarı ya da OAuth Kimlik Doğrulaması kullanılarak güvenliği sağlanmış uç noktalarla çalışır. OAuth için aşağıdaki akışlar desteklenir: yetkilendirme kodu, şifre ve istemci kimlik bilgileri.

API çağrınızı nasıl yetkilendireceğinizi, Bu API'yi deneyin panelinin bağlantısını nasıl kaldıracağınızı, ilgili spesifikasyonu nasıl indireceğinizi ve API'yi nasıl yürüteceğinizi gösteren açıklama metinlerinin yer aldığı API referans dokümanları sayfası.

Tam ekran'ı tıklayarak Bu API'yi deneyin panelini genişletin. Genişletilmiş panel, aşağıdaki şekilde gösterildiği gibi curl çağrısını ve kod örneklerini HTTP, Python, Node.js gibi çeşitli biçimlerde görüntülemenize olanak tanır.

Genişletilmiş "Bu API'yi deneyin" paneli

GraphQL Explorer

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

Geliştiriciler, şemaya dayalı etkileşimli dokümanları keşfetmek, sorgu oluşturup çalıştırmak, sorgu sonuçlarını görüntülemek ve şemayı indirmek için GraphQL Explorer'ı kullanabilir. Geliştiriciler, API'nize erişimi güvenli hale getirmek için Request Headers (İstek Başlıkları) bölmesinde yetkilendirme başlıkları iletebilir.

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

Portaldaki GraphQL Explorer

Anlık görüntü nedir?

Her OpenAPI veya GraphQL belgesi, API'nin yaşam döngüsü boyunca tek doğru kaynak olarak kullanılır. Aynı belge, API yaşam döngüsünün her aşamasında (geliştirme, yayınlama ve izleme) kullanılır. Bir belgeyi değiştirdiğinizde, Bir belgeyi değiştirirsem ne olur? başlıklı makalede açıklandığı gibi, değişikliklerin diğer yaşam döngüsü aşamalarında API'niz üzerindeki etkisini göz önünde bulundurmanız gerekir.

API'nizi yayınladığınızda, API referans belgelerini oluşturmak için OpenAPI veya GraphQL dokümanının anlık görüntüsünü alırsınız. Bu anlık görüntü, belgenin belirli bir sürümünü temsil eder. Dokümanda değişiklik yaparsanız API referans belgelerindeki en son değişiklikleri yansıtmak için dokümanın başka bir anlık görüntüsünü alabilirsiniz.

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

Uygulamalarınızın geri çağırma URL'si gerektirmesi durumunda (ör. OAuth 2.0 yetkilendirme kodu verme türü kullanılırken, bu tür genellikle üç aşamalı OAUTH olarak adlandırılır) geliştiricilerin uygulamalarını kaydettirirken geri çağırma URL'si belirtmelerini zorunlu kılabilirsiniz. Geri çağırma URL'si genellikle istemci uygulaması adına yetkilendirme kodu alacak şekilde belirlenmiş 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'si gerekip gerekmediğini yapılandırabilirsiniz. Bu ayarı, Bir API için geri arama URL'sini yönetme başlıklı makalede açıklandığı şekilde istediğiniz zaman değiştirebilirsiniz.

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

API proxy'nizi "Bu API'yi deneyin" özelliğini destekleyecek şekilde yapılandırma

API'lerinizi OpenAPI dokümanı kullanarak yayınlamadan önce API proxy'nizi, SmartDocs API referans belgelerindeki Bu API'yi deneyin panelinde istekte bulunmayı destekleyecek şekilde yapılandırmanız gerekir.

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

    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 uygulanan aynı kaynak politikasına yönelik 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 göre SmartDocs API referans dokümanlarındaki Bu API'yi deneyin panelini desteklemek için API proxy yapılandırma şartları özetlenmektedir.

Auth erişimi Politika yapılandırmasıyla ilgili şartlar
Yok veya API anahtarı API proxy'nize CORS desteği ekleyin. 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 bölümünde 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. 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 bölümünde açıklanan adımları uygulayın.
  2. Add CORS AssignMessage 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ı için GitHub'da sağlanan örnek CORS çözümünü kullanın veya API proxy'sine CORS desteği ekleme bölümünde açıklanan adımları uygulayın.
  2. Add CORS AssignMessage 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ızdaki RFC'ye uygun olmayan davranışları 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 <GrantType> bölümüne bakın.
    • OAuth2 politikasındaki token_type değerinin varsayılan BearerToken yerine Bearer olarak ayarlandığından emin olun.

API'leri yönetin

API'lerinizi aşağıdaki bölümlerde açıklandığı şekilde yönetebilirsiniz.

API'leri keşfet

Portalınızdaki API'leri görüntülemek için kullanıcı arayüzünü veya curl komutunu kullanın.

UI

API kataloğunu görüntülemek için:

  1. Yayınla > Portallar'ı seçip portalınızı belirleyin.
  2. Portal ana sayfasında API kataloğu'nu tıklayın. Alternatif olarak, üst gezinme çubuğundaki portal açılır menüsünde 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 spesifikasyon ve değiştirilme zamanı gibi API&#39;lerle ilgili bilgileri gösteren API&#39;ler sekmesi

Önceki şekilde vurgulandığı gibi, API'ler sekmesi ile şunları yapabilirsiniz:

curl

API'leri listelemek için:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
    -H "Authorization: Bearer ACCESS_TOKEN"

Aşağıdakini değiştirin:

  • ORG_NAME ile kuruluşun adı. Örneğin, my-org.
  • SITE_ID, portalın adıyla birlikte şu biçimde olmalıdır: ORG_NAME-PORTAL_NAME. Burada ORG_NAME, kuruluşun adı, PORTAL_NAME ise portal adının tüm harfleri küçük olacak şekilde ve boşluklar ile tireler kaldırılmış olarak dönüştürülmüş halidir. Örneğin, my-org-myportal.
  • ACCESS_TOKEN ile Apigee Edge API'ye erişmek için kullanılan kimlik doğrulama jetonu. Kimlik doğrulama ve jetonlar hakkında daha fazla bilgi için Edge API'ye erişimin kimliğini doğrulama başlıklı makaleyi inceleyin.

Yanıt yükünde sayfalara ayırmayı kullanma talimatları için Sayfalara ayırma notları'na bakın.

Yanıt yükü:

{
  "status": "success",
  "message": "one page of apidocs returned",
  "data": [
    {
      "id": 622759,
      "siteId": "my-org-myportal",
      "title": "Test",
      "description": "",
      "published": false,
      "visibility": false,
      "apiId": "apiproducttest18",
      "apiProductName": "apiproduct_test18",
      "edgeAPIProductName": "apiproduct_test18",
      "specId": null,
      "specContent": null,
      "specTitle": null,
      "snapshotExists": false,
      "snapshotModified": null,
      "modified": 1724144471000,
      "anonAllowed": false,
      "imageUrl": null,
      "snapshotState": null,
      "requireCallbackUrl": false,
      "categoryIds": [],
      "specFormat": null,
      "specModified": null,
      "snapshotOutdated": false,
      "snapshotSourceMissing": false,
      "graphqlSchema": null,
      "graphqlEndpointUrl": null,
      "graphqlSchemaDisplayName": null,
      "grpcFileName": null,
      "grpcZipContent": null
    }
  ],
  "code": null,
  "request_id": "1452867334",
  "error_code": null,
  "next_page_token": ""
}

Burada:

  • modified: Katalog öğesinin son değiştirildiği zaman (epoch'tan bu yana milisaniye cinsinden). Örneğin, 1698165480000.
  • id: Katalog öğesinin kimliği. Örneğin, 399668.

Sayfalama notları:

  • Sayfa boyutu: Bir sayfada döndürülecek liste öğelerinin sayısını belirtmek için pageSize kullanın. Varsayılan değer 25, maksimum değer ise 100'dür. Başka sayfalar varsa nextPageToken alanına bir jeton eklenir:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs?pageSize=PAGE_SIZE" \
   -H "Authorization: Bearer ACCESS_TOKEN"

    Değiştir:

    • PAGE_SIZE ile birlikte bir sayfada döndürülecek liste öğelerinin sayısı. Örneğin, 10.

    Yanıt yükü:

    {
  "status": "success",
  "message": "one page of apidocs returned",
  "data": [
    {
      "id": 638007,
      "siteId": "tsnow-mint-liztest",
      "title": "Testing",
      "description": "",
      "published": false,
      "visibility": false,
      "apiId": "testcatalog",
      "apiProductName": "testcatalog",
      "edgeAPIProductName": "testcatalog",
      "specId": "Petstore",
      "specContent": null,
      "specTitle": null,
      "snapshotExists": true,
      "snapshotModified": 1726508367000,
      "modified": 1728582504000,
      "anonAllowed": false,
      "imageUrl": null,
      "snapshotState": "OK_SUBMITTED",
      "requireCallbackUrl": false,
      "categoryIds": [],
      "specFormat": "YAML",
      "specModified": null,
      "snapshotOutdated": false,
      "snapshotSourceMissing": false,
      "graphqlSchema": null,
      "graphqlEndpointUrl": null,
      "graphqlSchemaDisplayName": null,
      "grpcFileName": null,
      "grpcZipContent": null
    }
  ],
  "code": null,
  "request_id": "1068810934",
  "error_code": null,
  "next_page_token": ""
}

  • Sayfa jetonu: Birden fazla sayfa olduğunda sonraki sayfaları almak için pageToken kullanın:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs?pageSize=PAGE_SIZE&pageToken=PAGE_TOKEN" \
      -H "Authorization: Bearer ACCESS_TOKEN"

    Değiştir:

    • PAGE_SIZE ile birlikte bir sayfada döndürülecek liste öğelerinin sayısı. Örneğin, 10.
    • nextPageToken değeriyle PAGE_TOKEN. Örneğin, 7zcqrin9l6xhi4nbrb9.

API ekleme

API'leri portalınıza eklemek için kullanıcı arayüzünü veya curl komutunu kullanın:

UI

Portalınıza API eklemek için:

  1. API kataloğuna erişin.
  2. Henüz seçilmemişse API'ler sekmesini tıklayın.

  3. + Ekle'yi tıklayın.

    Kataloğa bir API ürünü ekleyin iletişim kutusu gösterilir.

  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österilir.

  6. API referans belgeleri içeriğini ve portalda 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. Bu ayarı daha sonra Publish or unpublish an API on your portal (API'yi portalınızda yayınlama veya yayından kaldırma) başlıklı makalede açıklandığı şekilde değiştirebilirsiniz.
    Görünen başlık Katalogda gösterilen 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 başlıklı makalede açıklandığı şekilde 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. Görünen açıklamayı daha sonra Görünen başlığı ve açıklamayı düzenleme başlıklı makalede açıklandığı şekilde değiştirebilirsiniz.
    Geliştiricilerin geri çağırma URL'si belirtmesini zorunlu kılma Uygulama geliştiricilerin geri çağırma URL'si belirtmesini zorunlu kılmak istiyorsanız bu ayarı 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ığı gibi ekleyebilir veya güncelleyebilirsiniz.
    API belgeleri

    OpenAPI dokümanı kullanmak için:

    1. OpenAPI belgesi'ni seçin.
    2. Belge seç'i tıklayın.
    3. Aşağıdaki adımlardan birini uygulayın:
      • My Specs (Özelliklerim) sekmesini tıklayın ve özellik mağazasından bir özellik seçin.
      • Dosya Yükle sekmesini tıklayın ve 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ı (GraphQL Şeması) seçin.
    2. Belge Seç'i tıklayın.
    3. GraphQL şemasına gidip bu şemayı seçin.
    4. Seç'i tıklayın.

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

    • Tüm kullanıcıların API'yi görüntülemesine izin vermek için anonim kullanıcılar.
    • Yalnızca kayıtlı kullanıcıların API'yi görüntülemesine izin vermek için Kayıtlı kullanıcılar'ı seçin.

    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üleyebilmesini istediğiniz belirli kitleleri seçmek için Seçilen kitleler

    Kitle görünürlüğünü daha sonra Portalınızda bir API'nin görünürlüğünü yönetme başlıklı makalede açıklandığı şekilde yönetebilirsiniz.

    Görünen resim API'ler sayfasındaki API kartında bir resim göstermek 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 API kartı için resmi yönetme başlıklı makalede açıklandığı gibi resim ekleyebilirsiniz. Harici URL'ye sahip bir resim belirtildiğinde resim, öğelerinize yüklenmez. Ayrıca, entegre portalda resmin yüklenmesi, kullanılabilirliğine bağlıdır. Bu durum, içerik güvenlik politikaları tarafından engellenebilir veya kısıtlanabilir.
    Kategoriler

    Uygulama geliştiricilerin API'ler sayfasında ilgili API'leri keşfedebilmesi için API'nin etiketleneceği kategorileri ekleyin. Bir kategoriyi belirlemek 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 eklenir ve diğer API'ler eklenirken veya düzenlenirken kullanılabilir.

  7. Kaydet'i tıklayın.

curl

Portalınıza API eklemek için :

curl -X POST "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "description": "DESCRIPTION",
       "anonAllowed": ANON_TRUE_OR_FALSE,
       "imageUrl": "IMAGE_URL",
       "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
       "categoryIds": [
         "CATEGORY_ID1",
         "CATEGORY_ID2"
       ],
       "published": PUBLISHED_TRUE_OR_FALSE,
        "apiProductName": "API_PRODUCT"
    }'

Aşağıdakini değiştirin:

  • ORG_NAME ile kuruluşun adı. Örneğin, my-org.
  • SITE_ID, portalın adıyla birlikte şu biçimde olmalıdır: ORG_NAME-PORTAL_NAME. Burada ORG_NAME, kuruluşun adı, PORTAL_NAME ise portal adının tüm harfleri küçük olacak şekilde ve boşluklar ile tireler kaldırılmış olarak dönüştürülmüş halidir. Örneğin, my-org-myportal.
  • ACCESS_TOKEN ile Apigee Edge API'ye erişmek için kullanılan kimlik doğrulama jetonu. Kimlik doğrulama ve jetonlar hakkında daha fazla bilgi için Edge API'ye erişimin kimliğini doğrulama başlıklı makaleyi inceleyin.
  • TITLE ile görünen başlık. Örneğin, Hello World 2.
  • DESCRIPTION ile ekran açıklamasını kullanın. Örneğin, Simple hello world example.
  • ANON_TRUE_OR_FALSE ile true veya false (varsayılan) ile birlikte. Burada true, bu API'nin herkese açık görünürlüğe sahip olduğu ve anonim olarak görüntülenebileceği anlamına gelir. Aksi takdirde, yalnızca kayıtlı kullanıcılar görüntüleyebilir.
  • IMAGE_URL ile katalog öğesi için kullanılan bilinmeyen kaynaktan gelen bir resmin URL'si veya portalda depolanan resim dosyaları için bir dosya yolu (ör. /files/book-tree.jpg) ile değiştirin. Harici bir resmin URL'si belirtilirken resim öğelerinize yüklenmez. Ayrıca, entegre portalda resmin yüklenmesi, kullanılabilirliğine bağlıdır. Bu durum, İçerik Güvenliği Politikaları tarafından engellenebilir veya kısıtlanabilir.
  • CALLBACK_TRUE_OR_FALSE ile true veya false (varsayılan) olarak ayarlanır. Burada: true, uygulama yönetilirken portal kullanıcısının bir URL girmesini gerektirir.
  • CATEGORY_ID ile kategori kimliği. Örneğin, bf6505eb-2a0f-47af-a00a-ded40ac72960. Birden fazla kategori kimliğini virgülle ayırın. list API categories komutuyla kategori kimliğini alın.
  • PUBLISHED_TRUE_OR_FALSE, true veya false (varsayılan) ile birlikte. Burada true, API'nin herkese açık olduğunu gösterir. Yayınlandıktan sonra tüm kullanıcılara, kimliği doğrulanmış kullanıcılara veya belirli kullanıcılara erişim izni verebilirsiniz.
  • API_PRODUCT ile API ürününün adı. Örneğin, Hello World 2.

Yanıt yükü:

{
  "status": "success",
  "message": "API created",
  "data": {
    "id": 662423,
    "siteId": "my-org-myportal",
    "title": "My Test Catalog 4",
    "description": "",
    "published": false,
    "visibility": false,
    "apiId": "uxb9wjua",
    "apiProductName": "uXB9wJUa",
    "edgeAPIProductName": "uXB9wJUa",
    "specId": null,
    "specContent": null,
    "specTitle": null,
    "snapshotExists": false,
    "snapshotModified": null,
    "modified": 1729635493000,
    "anonAllowed": false,
    "imageUrl": null,
    "snapshotState": null,
    "requireCallbackUrl": false,
    "categoryIds": [],
    "specFormat": null,
    "specModified": null,
    "snapshotOutdated": null,
    "snapshotSourceMissing": false,
    "graphqlSchema": null,
    "graphqlEndpointUrl": null,
    "graphqlSchemaDisplayName": null,
    "grpcFileName": null,
    "grpcZipContent": null
  },
  "code": null,
  "request_id": "893346193",
  "error_code": null
}

Burada:

  • modified: Katalog öğesinin son değiştirildiği zaman (epoch'tan bu yana milisaniye cinsinden). Örneğin, 1698165480000.
  • id: Katalog öğesinin kimliği. Örneğin, 399668.

API düzenleme

API ekledikten sonra düzenleme yapmak için kullanıcı arayüzünü veya bir API çağrısını kullanın.

Bu bölümde, portalınızdaki mevcut bir API'yi değiştirmek için yapmanız gereken adımlarla ilgili ayrıntılı bir örnek verilmektedir.

Belirli değişiklik ayarları için sonraki bölümlere bakın.

UI

API'yi düzenlemek için:

  1. API kataloğuna erişin.
  2. Henüz 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 simgesiDüzenle'yi tıklayın.
  5. API ayrıntıları bölümünde değişiklik yapın. Seçeneklerin açıklamaları için API ekleme bölümüne bakın.
  6. Kaydet'i tıklayın.

curl

Bir API ekledikten sonra düzenleme yapmak için update (güncelle) çağrısını kullanın.

Bu örnekte, portalınızdaki API'nizin yayınlanma durumunu true yerine false olarak değiştirmek için gereken adımlar açıklanmaktadır. Gerekirse tek bir API çağrısında birden fazla ayarı değiştirebilirsiniz.

  1. Her API'yi benzersiz şekilde tanımlayan oluşturulmuş id değerini bulmak için API'leri keşfetme bölümünde açıklandığı gibi portalınızdaki API'lerin listesini alın.

  2. Belirli bir API'nin mevcut değerlerini döndürme:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
-H "Authorization: Bearer ACCESS_TOKEN"

    Aşağıdakini değiştirin:

    • ORG_NAME ile kuruluşun adı. Örneğin, my-org.
    • SITE_ID, portalın adıyla birlikte şu biçimde olmalıdır: ORG_NAME-PORTAL_NAME. Burada ORG_NAME, kuruluşun adı, PORTAL_NAME ise portal adının tüm harfleri küçük olacak şekilde ve boşluklar ile tireler kaldırılmış olarak dönüştürülmüş halidir. Örneğin, my-org-myportal.
    • API_DOC ile dokümanın oluşturulan id. Örneğin, 399668. Bu değeri bulmak için list API docs (API dokümanlarını listele) komutunu kullanın.
    • ACCESS_TOKEN ile Apigee Edge API'ye erişmek için kullanılan kimlik doğrulama jetonu. Kimlik doğrulama ve jetonlar hakkında daha fazla bilgi için Edge API'ye erişimin kimliğini doğrulama başlıklı makaleyi inceleyin.

    Yanıt yükü:

    {
  "status": "success",
  "message": "apidoc returned",
  "data": {
    "id": 662423,
    "siteId": "my-org-myportal",
    "title": "My Test Catalog 4",
    "description": "",
    "published": false,
    "visibility": false,
    "apiId": "uxb9wjua",
    "apiProductName": "uXB9wJUa",
    "edgeAPIProductName": "uXB9wJUa",
    "specId": null,
    "specContent": null,
    "specTitle": null,
    "snapshotExists": false,
    "snapshotModified": null,
    "modified": 1729635493000,
    "anonAllowed": false,
    "imageUrl": null,
    "snapshotState": null,
    "requireCallbackUrl": false,
    "categoryIds": [],
    "specFormat": null,
    "specModified": null,
    "snapshotOutdated": false,
    "snapshotSourceMissing": false,
    "graphqlSchema": null,
    "graphqlEndpointUrl": null,
    "graphqlSchemaDisplayName": null,
    "grpcFileName": null,
    "grpcZipContent": null
  },
  "code": null,
  "request_id": "601210268",
  "error_code": null
}

  1. Tutmak istediğiniz değiştirilebilir değerleri update (güncelleme) çağrısına ekleyin ve değiştirmek istediğiniz değerleri değiştirin. Bir satırı atlarsanız varsayılan ayar kullanılır. Bu örnekte, yayınlanma ayarını false olarak değiştirin:true

    curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
 -H "Authorization: Bearer ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{
    "title": "TITLE",
    "anonAllowed": true,
    "published": true
 }'

    Aşağıdakini değiştirin:

    • TITLE ile görünen başlık. Örneğin, Hello World 2.

    Yanıt yükü:

    {
  "status": "success",
  "message": "ApiDoc updated",
  "data": {
    "id": 662423,
    "siteId": "my-org-myportal",
    "title": "My Test Catalog 4",
    "description": "",
    "published": true,
    "visibility": true,
    "apiId": "uxb9wjua",
    "apiProductName": "uXB9wJUa",
    "edgeAPIProductName": "uXB9wJUa",
    "specId": null,
    "specContent": null,
    "specTitle": null,
    "snapshotExists": false,
    "snapshotModified": null,
    "modified": 1729989250000,
    "anonAllowed": true,
    "imageUrl": null,
    "snapshotState": null,
    "requireCallbackUrl": false,
    "categoryIds": [],
    "specFormat": null,
    "specModified": null,
    "snapshotOutdated": null,
    "snapshotSourceMissing": false,
    "graphqlSchema": null,
    "graphqlEndpointUrl": null,
    "graphqlSchemaDisplayName": null,
    "grpcFileName": null,
    "grpcZipContent": null
  },
  "code": null,
  "request_id": "738172002",
  "error_code": null
}

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 belgelerini 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şin.
  2. Henüz 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österilir: Anlık görüntünün güncel olmadığını belirten 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'nin belgelerini oluşturmak için kullanılan dokümanı değiştirmek üzere API belgeleri bölümünde Doküman Seç'i tıklayın ve yeni dokümanı seçin.
  7. Kaydet'i tıklayın.

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

Yayınlama, API'lerinizi uygulama geliştiricilerin kullanımına sunma sürecidir.

Portalınızda bir API'yi yayınlamak veya yayından kaldırmak için kullanıcı arayüzünü ya da curl komutunu kullanın.

UI

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

  1. API kataloğuna erişin.
  2. Henüz 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 Düzenle'yi tıklayın.
  5. API ayrıntıları bölümünde, API'yi portalınızda yayınlamak veya yayından kaldırmak için sırasıyla Yayınlandı (katalogda listelendi) seçeneğini belirleyin veya temizleyin.
  6. Kaydet'i tıklayın.

curl

Güncelleme çağrısına aşağıdakilerden birini ekleyin:

"published": true,    # API is published to your portal
"published": false,   # API is not published in your portal

API'yi düzenlemek için:

  1. Geçerli değerleri döndürme:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
-H "Authorization: Bearer ACCESS_TOKEN"

  2. API'yi düzenlemek için update çağrısını kullanın. Tutmak ve değiştirmek istediğiniz değiştirilebilir değerleri ekleyin. Değiştirmek istediğiniz değerleri değiştirin. Değiştirilebilir bir ayarı atlarsanız bu ayarın üzerine varsayılan değer yazılır.

    curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/  ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
 -H "Authorization: Bearer ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{
    "title": "TITLE",
    "description": "DESCRIPTION",
    "anonAllowed": ANON_TRUE_OR_FALSE,
    "imageUrl": IMAGE_URL,
    "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
    "categoryIds": [
      "CATEGORY_ID1",
     "CATEGORY_ID2"
    ],
    "published": PUBLISHED_TRUE_OR_FALSE
}

Adımlar, değişkenler ve döndürülen yükle ilgili ayrıntılı bir örnek için Belgenin sürümünü yönetme başlıklı makaleyi inceleyin.

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

Aşağıdakilere erişime izin vererek portalınızdaki bir API'nin görünürlüğünü yönetin:

Portalınızda bir API'nin görünürlüğünü yönetmek için kullanıcı arayüzünü veya curl komutunu kullanın:

UI

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

  1. API kataloğuna erişin.
  2. Henüz 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 Düzenle'yi tıklayın.

  5. 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ülemesine izin vermek için Herkese açık (herkes tarafından görülebilir)'i seçin.
    • Yalnızca kayıtlı kullanıcıların sayfayı görüntülemesine izin vermek için kimliği doğrulanmış kullanıcılar.
    • Sayfayı görüntüleyebilmesini istediğiniz kitleleri seçmek için Seçilen kitleler'i kullanın. Portalınızın kitlelerini yönetme başlıklı makaleyi inceleyin.
    Aksi takdirde, 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'ı seçin.
    • Sayfayı yalnızca kayıtlı kullanıcıların görüntülemesine izin vermek için Kayıtlı kullanıcılar'ı seçin.

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

curl

Kitle yönetimi özelliğinin beta sürümüne kaydolduysanız kitleleri yönetmek için kullanıcı arayüzünü kullanın.

Kitle yönetimi özelliğine kaydolmadıysanız görünürlük anonAllowed kullanılarak yönetilir.

update çağrısına aşağıdakilerden birini ekleyin:

  # When not enrolled in the beta release of the audience management feature:

  "anonAllowed": true,      # Anonymous users can see the API
  "anonAllowed": false,     # Only registered users can see the API

API'yi düzenlemek için:

  1. Geçerli değerleri döndürme:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
     -H "Authorization: Bearer ACCESS_TOKEN"

  2. API'yi düzenlemek için update (güncelleme) çağrısını kullanın. Tutmak istediğiniz değiştirilebilir değerleri ekleyin ve değiştirmek istediğiniz değerleri değiştirin. Değiştirilebilir bir ayarı atlarsanız varsayılan değer kullanılır.

    curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
     -H "Authorization: Bearer ACCESS_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
        "title": "TITLE",
        "description": "DESCRIPTION",
        "anonAllowed": ANON_TRUE_OR_FALSE,
        "imageUrl": IMAGE_URL,
        "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
        "categoryIds": [
          "CATEGORY_ID1",
          "CATEGORY_ID2"
        ],
        "published": PUBLISHED_TRUE_OR_FALSE
     }'

Adımlar, değişkenler ve döndürülen yük hakkında ayrıntılı bir örnek için API'yi düzenleme başlıklı makaleyi inceleyin.

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 kullanıcı arayüzünü veya curl komutunu kullanın:

UI

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

  1. API kataloğuna erişin.
  2. Henüz 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 Düzenle'yi tıklayın.
  5. API ayrıntıları bölümünde Geliştiricilerin geri arama URL'si belirtmesini zorunlu kıl onay kutusunu işaretleyin veya temizleyin.
  6. Kaydet'i tıklayın.

curl

update çağrısına aşağıdakilerden birini ekleyin:

  "requireCallbackUrl": true,    # Portal user is required to input a URL
  "requireCallbackUrl": false,   # Portal user is not required to input a URL

API'yi düzenlemek için:

  1. Geçerli değerleri döndürme:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
     -H "Authorization: Bearer ACCESS_TOKEN"

  2. API'yi düzenlemek için update (güncelleme) çağrısını kullanın. Tutmak istediğiniz değiştirilebilir değerleri ekleyin ve değiştirmek istediğiniz değerleri değiştirin. Değiştirilebilir bir ayarı atlarsanız varsayılan değer kullanılır.

    curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
     -H "Authorization: Bearer ACCESS_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
        "title": "TITLE",
        "description": "DESCRIPTION",
        "anonAllowed": ANON_TRUE_OR_FALSE,
        "imageUrl": IMAGE_URL,
        "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
        "categoryIds": [
          "CATEGORY_ID1",
          "CATEGORY_ID2"
        ],
        "published": PUBLISHED_TRUE_OR_FALSE
     }'

Adımlar, değişkenler ve döndürülen yük hakkında ayrıntılı bir örnek için API'yi düzenleme başlıklı makaleyi inceleyin.

API kartının resmini yönetme

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

API kartının resmini yönetmek için kullanıcı arayüzünü veya curl komutunu kullanın:

UI

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

  1. API kataloğuna erişin.
  2. Henüz 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 Düzenle'yi tıklayın.

  5. API ayrıntıları bölümünde:

    • Resim seçilmediyse bir resim belirtmek veya 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.

    Resim belirtirken katalog öğesi için kullanılan harici URL'ye sahip bir resmi veya portalda depolanan resim dosyalarının yolunu (ör. /files/book-tree.jpg) belirtin. Harici bir resmin URL'si belirtildiğinde resim öğelerinize yüklenmez. Ayrıca, entegre portalda resmin yüklenmesi, kullanılabilirliğine bağlıdır. Bu durum, İçerik Güvenliği Politikaları tarafından engellenebilir veya kısıtlanabilir.

  6. Kaydet'i tıklayın.

curl

Aşağıdakileri update çağrısına ekleyin:

  # Omit line for no image file

  "imageUrl": "IMAGE_URL"    # URL of the external image or name of the image file

API'yi düzenlemek için:

  1. Geçerli değerleri döndürme:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
     -H "Authorization: Bearer ACCESS_TOKEN"

  2. API'yi düzenlemek için update (güncelleme) çağrısını kullanın. Tutmak istediğiniz değiştirilebilir değerleri ekleyin ve değiştirmek istediğiniz değerleri değiştirin. Değiştirilebilir bir ayarı atlarsanız varsayılan değer kullanılır.

    curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
     -H "Authorization: Bearer ACCESS_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
        "title": "TITLE",
        "description": "DESCRIPTION",
        "anonAllowed": ANON_TRUE_OR_FALSE,
        "imageUrl": IMAGE_URL,
        "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
        "categoryIds": [
          "CATEGORY_ID1",
          "CATEGORY_ID2"
        ],
        "published": PUBLISHED_TRUE_OR_FALSE
     }'

Adımlar, değişkenler ve döndürülen yük hakkında ayrıntılı bir örnek için API'yi düzenleme başlıklı makaleyi inceleyin.

Kategorileri kullanarak API'leri etiketleme

Kategorileri kullanmak, uygulama geliştiricilerin ilgili API'leri keşfetmesine yardımcı olur. Ayrıca Kategorileri yönetme başlıklı makaleyi de inceleyin.

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

  • Aşağıda açıklandığı gibi, API'yi düzenlerken API'nin etiketlendiği kategorileri yönetin.
  • Kategoriyi düzenlerken kategoriye etiketlenmiş API'leri yönetin.

Bir API'yi kategorilerle etiketlemek için kullanıcı arayüzünü veya curl komutunu kullanın:

UI

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

  1. API kataloğuna erişin.
  2. Henüz 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 Düzenle'yi 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 eklenir ve diğer API'ler eklenirken veya düzenlenirken kullanılabilir.
  6. API'yi daha fazla kategoriyle etiketlemek için bu işlemi tekrarlayın.
  7. Kaydet'i tıklayın.

curl

Aşağıdakileri update çağrısına ekleyin:

  # Omit line for no categories

  "categoryIds": [
      "CATEGORY_ID1",      # A category ID number
      "CATEGORY_ID2"       # A category ID number
    ],

Kategori kimliği numaralarını almak için list categories komutunu kullanın.

API'yi düzenlemek için:

  1. Geçerli değerleri döndürme:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
     -H "Authorization: Bearer ACCESS_TOKEN"

  2. API'yi düzenlemek için update (güncelleme) çağrısını kullanın. Tutmak istediğiniz değiştirilebilir değerleri ekleyin ve değiştirmek istediğiniz değerleri değiştirin. Değiştirilebilir bir ayarı atlarsanız varsayılan değer kullanılır.

    curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
     -H "Authorization: Bearer ACCESS_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
        "title": "TITLE",
        "description": "DESCRIPTION",
        "anonAllowed": ANON_TRUE_OR_FALSE,
        "imageUrl": IMAGE_URL,
        "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
        "categoryIds": [
          "CATEGORY_ID1",
          "CATEGORY_ID2"
        ],
        "published": PUBLISHED_TRUE_OR_FALSE
     }'

Adımlar, değişkenler ve döndürülen yük hakkında ayrıntılı bir örnek için API'yi düzenleme başlıklı makaleyi inceleyin.

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

Görünen başlığı ve açıklamayı düzenlemek için kullanıcı arayüzünü veya curl komutunu kullanın:

UI

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

  1. API kataloğuna erişin.
  2. Henüz 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 Düzenle'yi tıklayın.
  5. Gerektiği gibi Görünen başlık ve Görünen açıklama alanlarını düzenleyin.
  6. Kaydet'i tıklayın.

curl

Aşağıdakileri update çağrısına ekleyin:

  "title": "TITLE",    # Display title
  "description": "DESCRIPTION",  # Display description

API'yi düzenlemek için:

  1. Geçerli değerleri döndürme:

    curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
     -H "Authorization: Bearer ACCESS_TOKEN"

  2. API'yi düzenlemek için update (güncelleme) çağrısını kullanın. Tutmak istediğiniz değiştirilebilir değerleri ekleyin ve değiştirmek istediğiniz değerleri değiştirin. Değiştirilebilir bir ayarı atlarsanız varsayılan değer kullanılır.

    curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
     -H "Authorization: Bearer ACCESS_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
        "title": "TITLE",
        "description": "DESCRIPTION",
        "anonAllowed": ANON_TRUE_OR_FALSE,
        "imageUrl": IMAGE_URL,
        "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
        "categoryIds": [
          "CATEGORY_ID1",
          "CATEGORY_ID2"
        ],
        "published": PUBLISHED_TRUE_OR_FALSE
     }'

Adımlar, değişkenler ve döndürülen yük hakkında ayrıntılı bir örnek için API'yi düzenleme başlıklı makaleyi inceleyin.

Portalınızdan API kaldırma

Bir API'yi portalınızdan kaldırmak için kullanıcı arayüzünü veya curl komutunu kullanın:

UI

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

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

curl

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

curl -X DELETE "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN"

Aşağıdakini değiştirin:

  • ORG_NAME ile kuruluşun adı. Örneğin, my-org.
  • SITE_ID, portalın adıyla birlikte şu biçimde olmalıdır: ORG_NAME-PORTAL_NAME. Burada ORG_NAME, kuruluşun adı, PORTAL_NAME ise portal adının tüm harfleri küçük olacak şekilde ve boşluklar ile tireler kaldırılmış olarak dönüştürülmüş halidir. Örneğin, my-org-myportal.
  • API_DOC ile dokümanın oluşturulan id. Örneğin, 399668. Bu değeri bulmak için list API docs (API dokümanlarını listele) komutunu kullanın.
  • ACCESS_TOKEN ile Apigee Edge API'ye erişmek için kullanılan kimlik doğrulama jetonu. Kimlik doğrulama ve jetonlar hakkında daha fazla bilgi için Edge API'ye erişimin kimliğini doğrulama başlıklı makaleyi inceleyin.

Yanıt yükü:

{
  "status": "success",
  "message": "Apidoc deleted",
  "data": {
  },
  "code": null,
  "request_id": "1790036484",
  "error_code": null
}

API belgelerini yönetme

Aşağıdaki bölümlerde API belgelerinin nasıl güncelleneceği, indirileceği veya kaldırılacağı açıklanmaktadır.

API belgelerini güncelleme

API belgelerinin farklı bir sürümünü yüklemek için:

UI

  1. API kataloğuna erişin.
  2. Henüz 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österilir: Anlık görüntünün güncel olmadığını belirten simge ve mesaj
  5. Düzenle'yi 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'nin dokümanlarını oluşturmak için kullanılan dokümanı değiştirmek üzere API dokümanları bölümünde Doküman Seç'i tıklayın ve yeni dokümanı seçin.
  7. API belgeleri bölmesinde aşağıdakilerden birini seçin:
    • OpenAPI dokümanı
    • GraphQL Şeması
  8. Doküman Seç'i tıklayın ve dokümanın en son sürümünü seçin.
  9. GraphQL için Uç nokta URL'sini belirtin.
  10. Kaydet'i tıklayın.

API referans belgeleri dokümandan oluşturulur ve API Referansı sayfasına eklenir. Anlık görüntü durumu güncel olarak güncellenir:

Simge ve mesaj, anlık görüntünün güncel olduğunu gösterir.

curl

OpenAPI veya GraphQL dokümanı içeriklerini güncellemek için:

OpenAPI

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"oasDocumentation": {
           "spec":{ "displayName":"DISPLAY_NAME",
                    "contents":"CONTENTS"}
            }
        }'

Aşağıdakini değiştirin:

  • ORG_NAME ile kuruluşun adı. Örneğin, my-org.
  • SITE_ID, portalın adıyla birlikte şu biçimde olmalıdır: ORG_NAME-PORTAL_NAME. Burada ORG_NAME, kuruluşun adı, PORTAL_NAME ise portal adının tüm harfleri küçük olacak şekilde ve boşluklar ile tireler kaldırılmış olarak dönüştürülmüş halidir. Örneğin, my-org-myportal.
  • API_DOC ile dokümanın oluşturulan id. Örneğin, 399668. Bu değeri bulmak için list API docs (API dokümanlarını listele) komutunu kullanın.
  • DISPLAY_NAME ile API belgelerinin görünen adı. Örneğin: Hello World 2
  • CONTENTS ile API dokümanlarının base64 kodlu dizesi. Çoğu geliştirme ortamında base64 dönüştürme yardımcı programı bulunur veya internette birçok dönüştürme aracı vardır.

Yanıt yükü:

{
 "status":"success",
 "message":"Api documentation updated",
 "requestId":"645138278"
 "data": {
   "oasDocumentation": {
     "spec": {
        "displayName": "Hello World 2"
      },
     "Format": "YAML"
   }
 }
}

GraphQL

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"graphqlDocumentation": {
         "schema":{"displayName":"DISPLAY_NAME",
         "contents":"CONTENTS"},
         "endpointUri": "ENDPOINT_URI"
          }
      }'

Aşağıdakini değiştirin:

  • ORG_NAME ile kuruluşun adı. Örneğin, my-org.
  • SITE_ID, portalın adıyla birlikte şu biçimde olmalıdır: ORG_NAME-PORTAL_NAME. Burada ORG_NAME, kuruluşun adı, PORTAL_NAME ise portal adının tüm harfleri küçük olacak şekilde ve boşluklar ile tireler kaldırılmış olarak dönüştürülmüş halidir. Örneğin, my-org-myportal.
  • API_DOC ile dokümanın oluşturulan id. Örneğin, 399668. Bu değeri bulmak için list API docs (API dokümanlarını listele) komutunu kullanın.
  • DISPLAY_NAME ile API belgelerinin görünen adı. Örneğin: Hello World 2
  • ENDPOINT_URI ile uç nokta URI'nizin alan adıyla değiştirin. Örneğin, https://demo.google.com/graphql.
  • CONTENTS ile API dokümanlarının base64 kodlu dizesi. Çoğu geliştirme ortamında base64 dönüştürme yardımcı programı bulunur veya internette birçok dönüştürme aracı vardır.

Yanıt yükü:

{
"status": "success",
"message": "ApiDocDocumentation updated",
"data": {
  "oasDocumentation": null,
  "graphqlDocumentation": {
    "schema": {
      "displayName": "schema.docs.graphql",
      "contents": ""
    },
    "endpointUri": "https://demo.google.com/graphql"
  }
},
"code": null,
"request_id": "640336173",
"error_code": null
}

API referans belgeleri dokümandan oluşturulur ve canlı portalın API'ler sayfasına eklenir.

API belgelerini indirme

API belgelerini indirmek için:

UI

curl

get documentation kullanarak API dokümanlarını indirmek için:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN"

Aşağıdakini değiştirin:

  • ORG_NAME ile kuruluşun adı. Örneğin, my-org.
  • SITE_ID, portalın adıyla birlikte şu biçimde olmalıdır: ORG_NAME-PORTAL_NAME. Burada ORG_NAME, kuruluşun adı, PORTAL_NAME ise portal adının tüm harfleri küçük olacak şekilde ve boşluklar ile tireler kaldırılmış olarak dönüştürülmüş halidir. Örneğin, my-org-myportal.

  • API_DOC ile dokümanın oluşturulan id. Örneğin, 399668. Bu değeri bulmak için list API docs (API dokümanlarını listele) komutunu kullanın.

    Yanıt yükü:

{
  "status": "success",
  "message": "ApiDocDocumentation returned",
  "data": {
    "oasDocumentation": {
      "spec": {
        "displayName": "mock",
        "contents": "b3BlbmFwaTogMy4wLjAKaW5mbzoKICBkZXNjcmlw ..."
      },
      "format": "YAML"
    },
    "graphqlDocumentation": null
  },
  "code": null,
  "request_id": "269996898",
  "error_code": null
}

Burada:

contents: API belgelerinin içeriğinin base64 kodlu dizesi.

API belgelerini kaldırma

API belgelerini kaldırmak için:

UI

  1. API kataloğuna erişin.
  2. Henüz 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'yi tıklayın.
  5. API dokümanları bölmesinde Doküman yok'u seçin.
  6. Kaydet'i tıklayın.

curl

Mevcut içeriği temizlemek için update API'yi kullanın:

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{}'

Aşağıdakini değiştirin:

  • ORG_NAME ile kuruluşun adı. Örneğin, my-org.
  • SITE_ID, portalın adıyla birlikte şu biçimde olmalıdır: ORG_NAME-PORTAL_NAME. Burada ORG_NAME, kuruluşun adı, PORTAL_NAME ise portal adının tüm harfleri küçük olacak şekilde ve boşluklar ile tireler kaldırılmış olarak dönüştürülmüş halidir. Örneğin, my-org-myportal.
  • API_DOC ile dokümanın oluşturulan id. Örneğin, 399668. Bu değeri bulmak için list API docs (API dokümanlarını listele) komutunu kullanın.

Yanıt yükü:

{
  "status": "success",
  "message": "ApiDocDocumentation updated",
  "data": {
    "oasDocumentation": null,
    "graphqlDocumentation": null
  },
  "code": null,
  "request_id": "304329676",
  "error_code": null
}

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

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

Kategorileri keşfedin

Portalınızdaki API'leri görüntülemek için kullanıcı arayüzünü veya curl komutunu kullanın.

UI

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

  1. Yayınla > Portallar'ı seçip portalınızı belirleyin.
  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österilir.

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ı şunları yapmanıza olanak tanır:

curl

Kategori listelemek için:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories" \
    -H "Authorization: Bearer ACCESS_TOKEN"

Aşağıdakini değiştirin:

  • ORG_NAME ile kuruluşun adı. Örneğin, my-org.
  • SITE_ID, portalın adıyla birlikte şu biçimde olmalıdır: ORG_NAME-PORTAL_NAME. Burada ORG_NAME, kuruluşun adı, PORTAL_NAME ise portal adının tüm harfleri küçük olacak şekilde ve boşluklar ile tireler kaldırılmış olarak dönüştürülmüş halidir. Örneğin, my-org-myportal.
  • ACCESS_TOKEN ile Apigee Edge API'ye erişmek için kullanılan kimlik doğrulama jetonu. Kimlik doğrulama ve jetonlar hakkında daha fazla bilgi için Edge API'ye erişimin kimliğini doğrulama başlıklı makaleyi inceleyin.

Yanıt yükü:

{
  "status": "success",
  "message": "all ApiCategory items returned",
  "data": [
    {
      "id": "e0518597-ece2-4d7d-ba7c-d1793df0f8db",
      "siteId": "my-org-myportal",
      "name": "My Category"
    },
    {
      "id": "61c1014c-89c9-40e6-be3c-69cca3505620",
      "siteId": "my-org-myportal",
      "name": "test2"
    }
  ],
  "code": null,
  "request_id": "1263510680",
  "error_code": null
}

Burada:

  • id: Kategori öğesinin kimliği. Örneğin, 61c1014c-89c9-40e6-be3c-69cca3505620.

Kategori ekleme

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

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

Yeni kategori, Kategoriler sayfasına eklenir ve diğer API'ler eklenirken veya düzenlenirken kullanılabilir.

Kategori eklemek için kullanıcı arayüzünü veya curl komutunu kullanın:

UI

Kategoriyi manuel olarak eklemek için:

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

curl

Kategori eklemek için:

curl -X POST "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "CATEGORY_NAME" }'

Aşağıdakini değiştirin:

  • ORG_NAME ile kuruluşun adı. Örneğin, my-org.
  • SITE_ID, portalın adıyla birlikte şu biçimde olmalıdır: ORG_NAME-PORTAL_NAME. Burada ORG_NAME, kuruluşun adı, PORTAL_NAME ise portal adının tüm harfleri küçük olacak şekilde ve boşluklar ile tireler kaldırılmış olarak dönüştürülmüş halidir. Örneğin, my-org-myportal.
  • ACCESS_TOKEN ile Apigee Edge API'ye erişmek için kullanılan kimlik doğrulama jetonu. Kimlik doğrulama ve jetonlar hakkında daha fazla bilgi için Edge API'ye erişimin kimliğini doğrulama başlıklı makaleyi inceleyin.
  • CATEGORY_NAME ile kategori adını girin. Örneğin, demo-backend.

Yanıt yükü:

{
  "status": "success",
  "message": "API category created",
  "data": {
    "id": "61de810e-b48b-4cc1-8f22-959038aadcce",
    "siteId": "my-org-myportal",
    "name": "demo-backend"
  },
  "code": null,
  "request_id": "363146927",
  "error_code": null
}

Kategori düzenleme

Bir kategoriyi düzenlemek için kullanıcı arayüzünü veya curl komutunu kullanın:

UI

Bir kategoriyi düzenlemek için:

  1. Kategoriler sayfasına erişin.
  2. Düzenle'yi tıklayın.
  3. Kategorinin adını düzenleyin.
  4. API etiketleri ekleme veya kaldırma
  5. Kaydet'i tıklayın.

curl

Bir kategoriyi düzenlemek için:

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories/CATEGORY_ID"  \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "CATEGORY_NAME" }'

Aşağıdakini değiştirin:

  • ORG_NAME ile kuruluşun adı. Örneğin, my-org.
  • SITE_ID, portalın adıyla birlikte şu biçimde olmalıdır: ORG_NAME-PORTAL_NAME. Burada ORG_NAME, kuruluşun adı, PORTAL_NAME ise portal adının tüm harfleri küçük olacak şekilde ve boşluklar ile tireler kaldırılmış olarak dönüştürülmüş halidir. Örneğin, my-org-myportal.
  • CATEGORY_ID ile kategori kimliği. Örneğin, bf6505eb-2a0f-47af-a00a-ded40ac72960. Birden fazla kategori kimliğini virgülle ayırın. list API categories komutuyla kategori kimliğini alın.
  • ACCESS_TOKEN ile Apigee Edge API'ye erişmek için kullanılan kimlik doğrulama jetonu. Kimlik doğrulama ve jetonlar hakkında daha fazla bilgi için Edge API'ye erişimin kimliğini doğrulama başlıklı makaleyi inceleyin.
  • CATEGORY_NAME ile kategori adını girin. Örneğin, demo-backend.

Yanıt yükü:

{
  "status": "success",
  "message": "ApiCategory updated",
  "data": {
    "id": "61de810e-b48b-4cc1-8f22-959038aadcce",
    "siteId": "my-org-myportal",
    "name": "demo-backend-test"
  },
  "code": null,
  "request_id": "1976875617",
  "error_code": null
}

Kategori silme

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

Bir kategoriyi silmek için kullanıcı arayüzünü veya curl komutunu kullanın:

UI

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. Sil'i tıklayın.
  4. İşlemi onaylamak için Sil'i tıklayın.

curl

Bir kategoriyi silmek için:

curl -X DELETE "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories/CATEGORY_ID" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json"

Aşağıdakini değiştirin:

  • ORG_NAME ile kuruluşun adı. Örneğin, my-org.
  • SITE_ID, portalın adıyla birlikte şu biçimde olmalıdır: ORG_NAME-PORTAL_NAME. Burada ORG_NAME, kuruluşun adı, PORTAL_NAME ise portal adının tüm harfleri küçük olacak şekilde ve boşluklar ile tireler kaldırılmış olarak dönüştürülmüş halidir. Örneğin, my-org-myportal.
  • CATEGORY_ID ile kategori kimliği. Örneğin, bf6505eb-2a0f-47af-a00a-ded40ac72960. list API categories komutuyla kategori kimliğini alın.
  • ACCESS_TOKEN ile Apigee Edge API'ye erişmek için kullanılan kimlik doğrulama jetonu. Kimlik doğrulama ve jetonlar hakkında daha fazla bilgi için Edge API'ye erişimin kimliğini doğrulama başlıklı makaleyi inceleyin.

Yanıt yükü:

{
  "status": "success",
  "message": "ApiCategory deleted",
  "data": {
  },
  "code": null,
  "request_id": "2032819627",
  "error_code": null
}

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 verilmektedir.

Hata: Bu API'yi deneyin kullanılırken döndürülen hata alınamadı

Try this API (Bu API'yi deneyin) kullanılırken TypeError: Failed to fetch hata döndürülürse olası nedenleri ve çözümleri aşağıda bulabilirsiniz:

Hata: "Access-Control-Allow-Origin" üstbilgisi birden fazla değer ("*, *") içeriyor ancak yalnızca bir değere izin veriliyor

Try 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 AssignMessage politikasını, aşağıdaki alıntıda gösterildiği gibi <Add> yerine CORS üstbilgilerini ayarlamak için <Set> kullanacak şekilde değiştirin. Daha fazla bilgi için CORS hatası : Başlık birden fazla değer ("*, *") içeriyor ancak yalnızca bir değere izin veriliyor başlıklı makaleyi 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

Try this API'yi kullanırken aşağıdaki örneğe benzer bir Request header field not allowed hata 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 AssignMessage politikanızdaki Access-Control-Allow-Headers bölümüne content-type başlığını eklemeniz gerekir.

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

Apigee'nin OAuthV2 politikası, RFC'ye uygun olmayan belirli özellikler içeren bir jeton yanıtı döndürüyor. Örneğin, politika, RFC'ye uygun olması beklenen Bearer değeri yerine BearerToken değerine sahip bir jeton döndürür. Bu geçersiz token_type yanıt, Try this API kullanılı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 AssignMessage politikası oluşturabilirsiniz. Daha fazla bilgi için RFC'ye uygun olmayan davranış başlıklı makaleyi inceleyin.