API'leri belgelemek için SmartDokümanlar'ı kullanma

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

ziyaret edin.

SmartDokümanlar, Drupal 7 geliştirici portalında API'lerinizi API belgeleri tamamen etkileşimlidir. Etkileşimli belgeler, portal kullanıcılarının şunları yapabilmesi anlamına gelir:

  • API'leriniz hakkında bilgi edinin
  • API'nize canlı istek gönderin
  • API'den döndürülen canlı yanıtı görüntüleme

API'lerinizle ilgili etkileşimli bir belge oluşturarak portal kullanıcısının API'lerini kullanmasını kolaylaştırırsınız. API'lerinizi öğrenin, test edin ve değerlendirin.

Edge Management API, herhangi bir cihazı kullanarak API Hizmetleri'ne erişmenizi sağlayan HTTP istemcisi. Apigee, Edge yönetimi için etkileşimli belgeler oluşturmak üzere Smart Docs'u kullanıyor API'ye gidin. Bu API belgelerini burada bulabilirsiniz.

SmartDokümanlar portalı örneği

SmartDokümanlar'ı kullanmak için bir Apigee Geliştirici Hizmetleri portalınızın olması gerekir. Daha fazla bilgi için bkz. Geliştirici oluşturma portalı olacaktır.

Geliştirici portalı ana sayfanızdan, yukarıdaki gezinme çubuğunda yer alan API'ler seçeneğini tıklayarak aşağıdaki işlemleri yapabilirsiniz: API Belgeleri sayfasını görüntüleyin.

Portalda belgelenmiş iki API vardır: Hello World ve Pet Store Örneği.

Hello World API, OpenAPI örnek hedefinden oluşturuldu Spesifikasyon, mocktarget.yaml. Daha fazla bilgi için https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi adresine bakabilirsiniz.

Evcil Hayvan Mağazası Örnek API'si, klasik evcil hayvan mağazası demosuyla oluşturulmuştur.

Hello World API'yi keşfedin:

  1. Hello World API'yi tıklayın. Hello World API özet sayfası gösteriliyor:
  2. API doğrulamasını göster'i tıklayın. Bu kaynak için SmartDokümanlar: gösterilen:
  3. Bu isteği gönder'i tıklayın.
  4. Döndürülen yanıtı görüntüleyin: 
    HTTP/1.1 200 OK
Connection:
keep-alive
Content-Length:
18
Content-Type:
text/html; charset=utf-8
Date:
Tue, 21 Jun 2016 21:49:32 GMT
ETag:
W/"12-Jb9QP1bUxNSmZkxQGt5KLQ"
X-Powered-By:
Apigee
<H2>I <3 APIs</H2>
    .
  5. İsteği veya cURL'yi görüntülemek için İstek sekmesini tıklayın. sekmesine giderek ilgili cURL çağrısını görüntüleyebilirsiniz.

SmartDokümanlar'ı kullanarak API'lerinizi belgeleme

SmartDokümanlar, API'lerinizi bir model kullanarak temsil eder. Bu model, modelin tüm daha fazla bilgi edineceksiniz. Portal, API'lerinizle ilgili bilgileri modelden portaldaki doküman sayfalarını Drupal düğümleri olarak oluştururlar. Burada her Drupal düğümü, bir belgenin bulunduğu sayfaya yönlendirir.

SmartDokümanlar'ı kullanmak için uyguladığınız genel adımlar şunlardır:

  1. Portalda Drupal SmartDokümanlar modülünü yapılandırın.
  2. SmartDokümanlar modeli oluşturun.
  3. Bir WADL dosyasından (OpenAPI (eski adıyla Swagger)) modele API'ler ekleme veya manuel olarak seçebilirsiniz.
  4. Modeli Drupal düğümlerinin bir koleksiyonu olarak oluşturun. Her bir Drupal düğümü tek bir API hakkında bilgi içeriyorsa. Örneğin, API'nizdeki bir kaynak hem POST ve bir PUT isteği ile Smart Docs, POST ve PUT için ayrı bir Drupal düğümü oluşturur.
  5. Drupal düğümlerini yayınlayın. Yayınlandıktan sonra portal kullanıcılarınız API'nizle etkileşime geçin.
  6. Drupal düğümlerini, yayınlamadan önce veya sonra düzenleyin. Şunları yapabilirsiniz: ya da Drupal düzenleyicisini kullanarak veya orijinal WADL dosyasını kullanarak Drupal düğümlerini düzenleyebilirsiniz. OpenAPI Spesifikasyonu. WADL dosyasını veya OpenAPI Spesifikasyonunu düzenlemeyi tamamladığınızda modelinize yeni bir düzeltme olarak geri ekleyin, ardından değişikliklerinizi oluşturup yayınlayın.
  7. TLS'yi etkinleştir. SmartDokümanlar, adresinize kimlik doğrulama kimlik bilgilerini gönderebileceği için daha sonra, API'lerinize istek göndermenin bir parçası olarak web arka ucunuzu kullanarak aşağıdaki işlemleri gerçekleştirmek için portalınızda TLS'yi etkinleştirmeniz ve bu kimlik bilgilerinin güvenli olduğundan emin olun. Portal üretim ve test ortamlarında Apigee, https:// isteklerinde bulunmak için gerekli olan TLS sertifikasını sağlar. Ancak gitmeden önce TLS sertifikanızı almanız ve TLS'yi etkinleştirmeniz gerekir. Daha fazla bilgi için bkz. portalı olacaktır.

SmartDoc modelleri ve şablonları hakkında

Portalınızda bir model oluşturduğunuzda bu model aslında Edge'inizde saklanır. bir kuruluş olduğunu tespit ettik. Model, dahili bir adı (ör. "my-smartdocs-api") ve bir API'nin yapısını tanımlar. Öte yandan portalınız, modeli HTML'de oluşturur ve model için bir düzenleme arayüzü sağlar. API'deki tüm güncellemeler otomatik olarak kaynak modele geri gönderilir.

Kuruluşta depolanıyor

Drupal'da depolanıyor

modeller

şablon

Düzenleme işlevlerine sahip Drupal düğümleri

Kuruluşunuzda birden fazla portalınız olduğunu varsayın (örneğin, geliştirici, aşama ve üretim) için geçerlidir. Pantheon'da portalları bir ortamdan diğerine taşırsınız. Her bir portalın kendi modelini içeriyor gibi görünür ama hepsi aslında kaynağa veya modeli. API'yi geliştirici sayfasında düzenlerseniz model güncellenir ve değişiklikler üretimde görünür. Benzer şekilde, geliştirici bölümünden bir modeli silerseniz kaynak da silinir ve bu model artık çok önemlidir.

Şablonlar, SmartDokümanlar'ınızın ve bu şablonların ( tutma yerleri ve CSS dosyaları) her portal örneğiyle birlikte depolanır. Her portal, Teorik olarak her model için benzersiz bir şablon kullanın. Ancak, oluşturma çerçevesinin kolaylıklarından biri, bir varsayılan şablonun (Apigee varsayılanı veya sağladığınız bir şablon) otomatik olarak her bir modele uygulanır.

Aşağıdaki şemada, modeller ve portallar arasındaki ilişki gösterilmektedir. Yeşil oklar otomatik senkronizasyon.

Aşağıdaki cURL komutu, kuruluşunuzdaki tüm modelleri listeler:

curl -v https://api.enterprise.apigee.com/v1/o/{your_org}/apimodels/ -u edge_org_admin@example.com

SmartDokümanlar modülünü yapılandırma

Apigee, Smart Docs'u özel bir Drupal modülü olarak uyguladı. Aşağıdaki prosedürü kullanarak SmartDokümanlar modülünün yapılandırılması.

SmartDokümanlar modülünü yapılandırmak için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Drupal yönetim menüsünde Modüller'i seçin. Tümünün listesi yüklü Drupal modüllerini görürsünüz.
  3. SmartDocs modülünü etkinleştirin.
  4. Yapılandırmayı kaydedin.
  5. Drupal yönetici menüsünde Modüller'i seçin.
  6. SmartDokümanlar -> öğesini seçin. İzinler ve "Yönetimi gerçekleştir" olduğundan emin olun görevleri ayarlamak" "Yönetici" için rolü etkinleştirildi.
  7. Yapılandırma > Drupal yönetimindeki Dev Portal tıklayın.
  8. Bağlantı Zaman Aşımı ve İstek Zaman Aşımı değerlerini 16'ya ayarlayın. saniye.
  9. Yapılandırmayı kaydedin.
  10. URL ayarlarını yapılandırın:
    1. Yapılandırma > Arama ve meta veriler > URL takma adları > Ayarlar'a gidin.
    2. Maksimum takma ad uzunluğu ve Maksimum bileşeni ayarlama uzunluk değerini 255 olarak değiştirin.
    3. Noktalama'yı genişletin.
    4. Sol kıvrık ayraç ({) ve Sağ kıvrık ayraç için (}) ayarlarında İşlem yok (değiştirme) seçeneğini belirleyin.
    5. Yapılandırmayı kaydet'i tıklayın.
  11. Geliştirici portalınız, dahili bir ağ üzerinde erişimi olmayan kullanıcılara sunulacaksa veya API'lerinizin bir alt kümesi özel bir ağdaysa SmartDokümanlar API'yi yapılandırın proxy URL'sini aşağıdaki gibi kullanın:
    1. Yapılandırma > Drupal Management'taki SmartDokümanlar tıklayın.
    2. Gelişmiş Ayarlar'ı genişletin.
    3. SmartDokümanlar proxy URL'si alanını aşağıdaki gibi güncelleyin: <host>/smartdocs/v1/sendrequest.
      . Satır içi yardım, ortamınız için gerekli değeri sağlamalıdır. Örneğin:
      https://api-us-east-1-enterprise.apigee.com/smartdocs/v1/sendrequest

      . Bu alanın varsayılan değeri https://apiconsole-prod.apigee.net/smartdocs/v1/sendrequest
    4. Yapılandırmayı kaydet'i tıklayın.

Model oluşturma

Model, API'nizin gösterimiyle ilgili tüm bilgileri içerir. Anahtar kelimelerin farklı API'leri desteklemek için portalda birden fazla model oluşturun veya tüm API'lerinizi tek bir modeli.

Her model, oluşturulan Drupal düğümlerinin sayısını temel alır. Her Drupal düğümünün URL'si şu biçimdedir:

http://<drupalBasePath>/<internalName>/apis/<httpMethod>/<resourcePath>

Bu örnekte:

  • drupalBasePath: Portalınızın temel URL'si.
  • internalName: Modelin dahili adı.
  • httpMethod: API'nin HTTP yöntemi. Örneğin: alın, koyun, gönderin veya sil.
  • resourcePath: Kaynak yolu.

Örneğin, dahili adı "mymodel" olarak belirtirseniz oluşturulan "/books" adlı bir kaynağa yapılan GET isteği için Drupal düğümü şununla eşleşir:

http://prod-myco.devportal.apigee.com/mymodel/apis/get/books

Model oluşturmak için

Bir model oluşturduğunuzda bu model API kaynağı olarak Edge kuruluşunuzda depolanır inceleyeceğiz. Daha fazla bilgi için SmartDoc modelleri hakkında ve şablonları ekleyin.

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. İçerik > Drupal yönetimindeki SmartDokümanlar tıklayın.
  3. Sayfanın üst kısmında Yeni model'i seçin.
  4. Aşağıdaki alanları girin:
    • Ad: Site genelinde gösterilecek model adı.
    • Dahili ad: Siz Ad'ı yazdıkça dahili görüntülenir. Modelin tüm modeller arasında benzersiz olması gereken dahili adı. Dahili ad yalnızca küçük harf, sayı ve boşluk içermeyen kısa çizgilerden oluşmalıdır. Bu adı düzenlemek için Düzenle'yi seçin.
    • Açıklama: Modelin bir açıklaması.
  5. Model Oluştur'u seçin.

Modeli oluşturduktan sonra modelin sayfasına yönlendirilirsiniz. Buradan yola çıkarak İşlemler açılır menüsünü kullanarak şunları yapabilirsiniz:

  • API'nizi açıklayan bir WADL dosyasını içe aktarın veya bir OpenAPI'nin URL'sini belirtin API'nizi açıklayan spesifikasyon.
  • Modele Düzeltme ekleme
  • Model Ayarlar'ını, kullandığı stil sayfaları da dahil olmak üzere modeli.
  • Modeli bir dosyaya aktarın.
  • Modeli silin.

Bir modele API ekleme

Bir modele aşağıdaki şekilde API ekleyebilirsiniz:

  • API tanımını içeren bir WADL dosyasını içe aktarma
  • OpenAPI Spesifikasyonunu içe aktarma (OpenAPI 2.0 veya 1.2)
  • Manuel olarak kaynak ve yöntem oluşturma

Ayrıca, bir SmartDokümanlar JSON dosyasını modele de aktarabilirsiniz. Bu dosya genelde önce mevcut bir modeli dışa aktarın, dosyayı düzenleyin ve sonra güncellemeleri içe aktarın. Daha fazlası için "Modeli dışa ve içe aktarma" bölümüne bakın. bölümüne göz atın.

Video: SmartDokümanlar modeline göre API'leri nasıl ekleyeceğinizi öğrenmek için bir OpenAPI Spesifikasyonu içe aktarma.

WADL içe aktarma

Modeli başarıyla oluşturduktan sonra, API'nizi açıklayan bir WADL dosyasını içe aktarın. Hepsini bir WADL dosyasını içe aktardığınızda modelin yeni bir düzeltmesini otomatik olarak oluşturursunuz.

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. İçerik > Drupal'daki SmartDokümanlar yönetim menüsü.
  3. Güncellemek istediğiniz modeli seçin.
  4. İşlemler bölümünde İçe aktar'ı seçin.
  5. WADL SmartDokümanlar içe aktarma sayfası.
  6. Yükleme{/1} bölümünde Dosya veya URL seçeneğini belirleyin Tür açılır listesi.
    1. Dosya'yı seçerseniz WADL dosyasına göz atın.
    2. URL'yi seçerseniz WADL dosyasının URL'sini belirtin.
  7. Etiketi modele aktarmak için İçe aktar'ı tıklayın. Artık şunları yapabilirsiniz: modeli oluşturmak.
  8. Modelin bilgi sayfasına yönlendirilirsiniz. Burada artık modeli.

OpenAPI'yi içe aktarma Spesifikasyon

Modelinizi başarıyla oluşturduktan sonra bir OpenAPI (eski adıyla Swagger) içe aktarabilirsiniz Spesifikasyon. Edge, OpenAPI sürüm 1.2 ve 2.0'ı destekler.

OpenAPI, bir API'yi tanımlamak için JSON nesneleri içeren dosyalar kullanır. Her içe aktarma işleminizde OpenAPI Spesifikasyonu'nu kullanırsanız modelin yeni bir düzeltmesini otomatik olarak oluşturursunuz.

Bir OpenAPI Spesifikasyonunu içe aktarmak için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Seç İçerik > SmartDokümanlar'ı, Drupal yönetim menüsü.
  3. Güncellemek istediğiniz modeli seçin.
  4. İşlemler bölümünde İçe aktar'ı seçin.
  5. Şu menüden Swagger JSON veya Swagger YAML'yi seçin: SmartDokümanlar içe aktarma sayfasında Biçim Seçin açılır listesi.
  6. Şu menüden Dosya veya URL'yi seçin: Yükleme Türü açılır listesi (OpenAPI 1.2 için URL'yi seçmeniz gerekir).
    1. File'ı (Dosya) seçerseniz OpenAPI'ye gidin. Spesifikasyon.
    2. URL'yi seçerseniz OpenAPI'nin URL'sini belirtin. Spesifikasyon.
  7. Etiketi modele aktarmak için İçe aktar'ı tıklayın.
  8. Modelin bilgi sayfasına yönlendirilirsiniz. Burada artık modeli.

Manuel olarak kaynak oluşturma ve yöntemler

API'nizi temsil eden bir WADL dosyanız veya OpenAPI Spesifikasyonunuz yoksa şunları yapabilirsiniz: modelinize manuel olarak API ekleyin. Ayrıca, yeni bir sürüm oluşturmak için WADL dosyası veya OpenAPI API'lerinizi düzenlemek için bu prosedürü kullanabilirsiniz. Buna, yeni API'ler eklemek de dahil olmak üzere, içe aktarın.

Manuel olarak API eklemek için:

  1. Modelin yeni bir düzeltmesini oluşturun.
    .
    . Düzeltmeyi oluştururken modeldeki tüm API'lerin tek temel yolunu belirtirsiniz. Yani bir modeldeki tüm API'ler aynı temel yolu paylaşır. Örneğin, temel yolu yön:

    . https://myCompany.com/v1

    . Modele kaynak eklediğinizde, temel yol genişletilir.
  2. Model için bir veya daha fazla kaynak tanımlayın. Kaynak yolu temel yolla birleştirilir kaynak URL'sini belirtin. Örneğin, kaynağınız "/login" yolunu tanımlar, kaynağın tam URL'si:

    . https://myCompany.com/v1/login
  3. Her kaynak için bir veya daha fazla yöntem tanımlayın. Bir yöntem, bir kaynakta çağrılır. Örneğin, "/login" giriş yapmak için POST'u destekliyorsunuz ve Çıkış yapmak için DELETE (SİL) tuşuna basın. Bu kaynak, PUT veya GET gibi diğer HTTP fiillerini desteklemiyor. Bu nedenle, kaynak için biri POST, diğeri DELETE için olmak üzere iki yöntem tanımlayın.
    .
    . Yöntem, üst kaynağındaki kaynak URL'sini kullanır. Bu nedenle, aynı boyuta sahip tüm yöntemler URL, SmartDokümanlar'da tek bir kaynak altında tanımlanır.

Genel kural olarak:

  • API'nizdeki her benzersiz temel yol için farklı bir SmartDokümanlar modeli oluşturun.
  • API'nızdaki her benzersiz kaynak için farklı bir SmartDokümanlar kaynağı tanımlayın.
  • Bir kaynak tarafından desteklenen her HTTP fiili için farklı bir SmartDokümanlar yöntemi tanımlayın.

Bir modelin yeni revizyonunu oluşturma

Yalnızca modelin mevcut bir düzeltmesine kaynak ekleyebilirsiniz. Modelin zaten bir kaynağınızı ekleyebilirsiniz. Model yeniyse ve herhangi bir düzeltmesi yoksa, yeni bir model kabul edersiniz.

Bir modelin yeni bir düzeltmesini oluşturmak için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Seç İçerik > SmartDokümanlar'ı yönetiyorum.
  3. Güncellemek istediğiniz model için Düzelt Ekle'yi seçin. İşlemler bölümünde bulabilirsiniz.
  4. API Düzeltmesi Ekle sayfasında aşağıdaki bilgileri girin:
    • Görünen Ad: Düzeltmenin portalında yer alır.
    • Sürüm kimliği: Düzeltme için kısa bir tanımlayıcı.
    • Açıklama: Düzeltmenin açıklaması.
    • Temel URL: Modelin düzeltmesindeki tüm API'lerin temel URL'si. CEVAP modeliniz her düzeltme için farklı temel URL'ler kullanabilir. Örneğin, açıklamaya göstergesi olabilir. İlk model düzeltmesi için temel URL şu şekildedir:
      https://myCompany.com/v1
      Bir sonraki düzeltme için temel URL şöyle olabilir:
      https://myCompany.com/v2
  5. Düzeltme Ekle'yi seçin. Modelin düzeltme sayfasına yönlendirilirsiniz. Artık model üzerinde kaynak tanımlayabilirsiniz.

Kaynak tanımlama

Kaynak, bir API'nin tam URL'sini belirtir. Bir kaynağı tanımlarken tam URL'yi oluşturmak için model düzeltmesindeki temel URL ile birleştirilen kaynak yolu emin olmanız gerekir.

Bir kaynağı tanımlamak için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Seç İçerik > SmartDokümanlar'ı yönetiyorum.
  3. Güncellemek istediğiniz model için İşlemler bölümünde API'yi seçin. Revizyonlar'ı tıklayın.
  4. Düzenlemek için bir düzeltme seçin.
  5. Düzeltme sayfasında, açılır menüden Kaynak Ekle'yi seçin.
  6. Kaynak Ekle sayfasında aşağıdaki bilgileri girin:
    • Görünen Ad: Kaynağın adı.
    • Yol: "/" ile başlayan kaynak yolu. The value of Yol, model düzeltmesinin Temel URL'si ile birleştirilir kullanarak kaynağın tam URL'sini oluşturun.
    • Açıklama: Kaynağın açıklaması.
    • Parametreler: İsteğe bağlı olarak her parametreyi tanımlayan JSON nesnesini girin. bu kaynakta değil. Bu parametreler aşağıda açıklanmıştır.
  7. Kaynak Ekle'yi seçin. Model sayfasına yönlendirilirsiniz. Artık şunları yapabilirsiniz: kaynakta yöntemleri tanımlamalısınız.

İsterseniz kaynağa şablon, sorgu ve başlık gibi parametreler ekleyebilirsiniz parametreleridir. Tüm kaynak parametreleri, söz konusu kaynakta tanımlanan tüm yöntemler tarafından devralınır. Dolayısıyla, kaynakta bir sorgu parametresi tanımlarsanız bu kaynağa tüm yöntemler eklenir bu sorgu parametresini desteklemelidir.

Alternatif olarak, parametreleri bir yöntemde tanımlayabilirsiniz. Örneğin, bir POST yöntemi DELETE yöntemiyle desteklenmeyen sorgu parametreleri. Bu nedenle, belirli bir yönteme özgü olduğunu unutmayın.

Aşağıdaki resimde, için mevcut bir Smart Docs sayfası gösterilmektedir Apigee'nin Geliştirici Uygulaması'nı Onaylama veya İptal Etme API'yi her bir parametre türü vurguluyor:

Her parametre türü bir JSON nesnesiyle tanımlanır:

Tür

JSON nesnesi

Notlar

Şablon

{
"dataType": "dize",
"defaultValue": "",
"description": "Kuruluş adı.",
. "name": "kuruluş_adı",
"zorunlu": doğru,
"type": "TEMPLATE"
}

Şablon parametreleri her zaman gereklidir. Bu nedenle gerekli değerini true olarak ayarlayın ve değeri defaultValue olarak ayarlamanız gerekir.

description değeri Kullanıcı bir SmartDokümanlar sayfasında URL'nin üzerine geldiğinde bir pop-up görüntülenir.

Sorgu

{
"dataType": "dize",
"defaultValue": "",
"description": "Konum.",
. "name": "w",
"zorunlu": doğru,
"type": "QUERY"
}

Gerekli sorgu parametreleri yine de bir defaultValue belirtebilir, ancak genellikle belirtmez.

İsteğe bağlı sorgu parametreleri için required değerini false olarak ayarlayın ve bir değer belirtin. defaultValue olarak ayarlamanız gerekir.

Başlık

{
"dataType": "dize",
"defaultValue": "uygulama/json",
"description": "<code>uygulama/json</code> olarak belirtin.",
"name": "İçerik Türü",
"zorunlu": doğru,
"type": "BAŞLIK"
}

Açıklamada HTML etiketlerini nasıl kullanabileceğinize dikkat edin.

Şablon parametresi, kaynak yolundaki bir değişkeni tanımlar. Örneğin, iki adet şablon parametreleri oluşturun. Parametre dizisindeki her bir parametre tanımının, virgülle ayrılır:

[
 {
  "dataType": "string",
  "defaultValue": "",
  "description": "Mention the organization name.",
  "name": "org_name",
  "required": true,
  "type": "TEMPLATE"
 },
 {
  "dataType": "string",
  "defaultValue": "",
  "description": "Mention the user email.",
  "name": "developer_email",
  "required": true,
  "type": "TEMPLATE"
 }
]

Daha sonra "{}" içinde yer alan kaynak Yol tanımındaki şablon parametrelerini kullanabilirsiniz. Örneğin, yolu şu şekilde ayarlayın:

/login/{org_name}/{developer_email}

SmartDokümanlar API sayfasında, kullanıcı URL'nin org_name ve developer_email bölümünü belirtmeden önce URL'yi düzenlemelidir. talep gönderebilirler.

Yöntem tanımlama

Her kaynak için bir veya daha fazla yöntem tanımlayın. Yöntem tanımı bir HTTP fiili belirtiyor bu dosyalar kaynakta çağrılabilir. Bir kaynakta tek bir yöntem tanımlanmış olabilir veya birden çok yöntem.

Yöntemi tanımlamanın bir parçası olarak, yöntem tarafından kullanılan tüm parametreleri belirtin. Buna sorgu, başlık parametreleri. Parametre eklemeyle ilgili bilgi için yukarıdaki açıklamaya bakın. bir yöntem sağlar.

Aşağıdaki resimde, Apigee Create Developer API için mevcut bir SmartDocuments sayfası gösterilmektedir: bir terimi tanımlarken belirlediğiniz karşılık gelen değerle vurgulanmış olarak yöntem:

Sonraki resimde, İstek Gövdesinin Açıklaması seçili olarak aynı sayfa gösterilmektedir:

Bir yöntem tanımlamak için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Seç İçerik > SmartDokümanlar'ı yönetiyorum.
  3. Güncellemek istediğiniz model için İşlemler bölümünde API'yi seçin. Revizyonlar'ı tıklayın.
  4. Düzenlemek için bir düzeltme seçin.
  5. Düzeltme sayfasında, aşağıdakilerden birinin açılır menüsünden Yöntem Ekle'yi seçin kaynaklar.
  6. Metodu Düzenle sayfasında aşağıdaki bilgileri girin:
    • Display Name (Görünen Ad): API'nin adıdır. Bu ad aynı zamanda API'nin Drupal sayfası.
    • Açıklama: API'yi açıklayın.
    • Yöntem Fiil: HTTP fiil türü.
    • Güvenlik Şemaları: yöntemidir. Daha fazla bilgi için SmartDokümanlar kimlik doğrulamasını yapılandırma türü ekleyin.
    • İçerik Türü: İsteğin ve yanıtın içerik türü. Bkz. bölümüne bakın.
    • Parametreler: (İsteğe bağlı) Yöntem için herhangi bir sorgu veya başlık parametresi. Daha fazla bilgi için kaynağa parametre eklemeyle ilgili yukarıdaki açıklamaya bakın.
    • İstek Gövdesi Belgeleri: (İsteğe bağlı) İsteğin gövdesini açıklayın. YAYINLAMA istek gövdesini alır. Bu alanı açıklamak için kullanabilirsiniz. Bunu atlarsanız değerinde ise İstek Gövdesi altındaki Açıklama bağlantısı atlanır. Google Dokümanlar dosyası oluşturun.
    • İstek Gövdesi Örneği: (İsteğe bağlı) İstek gövdesinin bir örneğini gösterin. JSON nesnesi olarak veya XML olarak. POST ve PUT fiilleri için Request Body Örnek her isteğin bir parçası olarak iletilir. SmartDokümanlar sayfasının kullanıcıları bunu düzenler daha fazla bilgi edinin. Bu değeri çıkarırsanız İstek Gövdesi altındaki Değer bağlantısı SmartDokümanlar sayfası oluşturuldu.
    • Etiketler: API ile ilişkilendirilen bir etiket dizisi. SmartDokümanlar şu amaçlar için etiketleri kullanır: benzer API'leri birlikte gruplandırır. Örneğin, "İstatistikler" tüm API'lere istatistikler hakkında Farklı kaynaklardan gelen API'leri tek bir etiket altında gruplandırabilirsiniz. o hepsinin aynı etiketi kullanması gerekir.
  7. Yöntem Ekle'yi seçin. Model sayfasına yönlendirilirsiniz. Artık şunları yapabilirsiniz: yönteminizi oluşturun ve yayınlayın.

Model oluşturma

API'leri ekledikten sonra modeli oluşturabilirsiniz. Oluşturma işlemi, modelin Drupal düğümlerine eklemeniz gerekir. Oluşturma işlemi tamamlandığında tek bir Drupal'ınız olur düğümünü ekleyin. Burada her Drupal düğümü bir HTML sayfasına karşılık gelir.

Modelin tamamını tek seferde oluşturmayı tercih edebilir veya modelin tamamı için ayrı ayrı API'ler seçebilirsiniz. oluşturma.

Bir modeli oluşturmak için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Seç İçerik > SmartDokümanlar'ı yönetiyorum.
  3. Oluşturmak istediğiniz model için API Revisions (API Düzeltmeleri) seçeneğini belirleyin. İşlemler.
  4. Oluşturmak istediğiniz düzeltmeyi seçin. Yalnızca şunun tek bir revizyonundan düğümleri oluşturabilirsiniz: bahsedeceğim.
  5. Oluşturma yöntemlerini seçin.
  6. Güncelle'den Düğüm Oluştur'u seçin. seçenekler açılır listesinden seçim yapabilirsiniz.
  7. Güncelle'yi tıklayın.
  8. Oluşturulan düğümlerinizin ilerleme durumunu görüntülemek için bir yükleme ekranı görünür.
    . Düğümler oluşturulduktan sonra her API için Drupal düğümünün kimliği Modelin Düğüm İlişkilendirmesi sütunu. Düğümdeki bağlantıyı tıklayın. İlişkilendirme sütununu ekleyin.

Düğüm Oluştur yerine Oluştur API'leri hemen bir Drupal düğümü olarak oluşturmak ve yayınlamak için düğümleri yayınlayabilir ve yayınlayabilirsiniz.

Düğümleri yayınlama

Bir düğüm, yayınlanana kadar portal kullanıcıları tarafından görülemez. İsterseniz yayınlama düğümlerini nasıl yayınlayacağınızı anlatacağız. Düğümleri yayınlamamayı seçerseniz oluşturma işlemi tamamlandıktan sonra bunları manuel olarak yayınlamanız gerekir.

Bir düğüm yayınlamak için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Seç İçerik > SmartDokümanlar'ı yönetiyorum.
  3. Yayınlamak istediğiniz model için API Revisions (API Düzeltmeleri) seçeneğini belirleyin. İşlemler.
  4. Yayınlamak istediğiniz düzeltmeyi seçin. Yalnızca tek bir düzeltmeden düğüm yayınlayabilirsiniz belirler.
  5. Yayınlama yöntemlerini seçin.
  6. Yayınlamak için düzeltmedeki düğümleri seçin.
  7. Güncelleme'de Yayınla Düğümleri'ni seçin. seçenekler açılır listesinden seçim yapabilirsiniz.
  8. Güncelle'yi tıklayın.
  9. Düğüm İlişkilendirmesi altında düğüm kimliğini seçerek düğüme gidin. sütununa girin.

Varsayılan olarak, yayınlanan bir API düğümünün Drupal URL'si şu biçimdedir: http://<drupalBasePath>/<internalName>/apis/<httpMethod>/<resourcePath>. URL'nin biçimini kontrol etmek için aşağıdaki prosedürü kullanın:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Yapılandırma > Arama ve meta veriler > URL takma adları > Kalıplar bölümüne gidin.
  3. Tüm SmartDokümanlar yöntem yolları için desen altında, yolu oluşturur.
  4. Yapılandırmayı kaydet'i seçin.

Portalda önbelleğe alma nedeniyle, model sayfalarınızın hemen göründüğünü fark edebilirsiniz . Gerekirse SmartDokümanlar HTML önbelleğini şu prosedürü izleyin:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Yapılandırma > Drupal yönetimindeki SmartDokümanlar tıklayın.
  3. SmartDokümanlar model önbelleklerini yeniden oluştur'u tıklayın.

Düğümü yayından kaldırma

Yayınlanmış bir düğümü istediğiniz zaman yayından kaldırabilirsiniz. Bir düğümü yayından kaldırdığınızda portal kullanıcıları.

Bir düğümü yayından kaldırmak için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Seç İçerik > SmartDokümanlar'ı yönetiyorum.
  3. Yayından kaldırmak istediğiniz model için API Düzeltmeleri'ni seçin. İşlemler.
  4. Yayından kaldırmak istediğiniz düğümün model düzeltmesini seçin.
  5. Yayından kaldırmak için düzeltmedeki düğümleri seçin.
  6. Güncelleme'de, Yayından Kaldır Düğümleri seçin. seçenekler açılır listesinden seçim yapabilirsiniz.
  7. Güncelle'yi tıklayın.

Bir modelin revizyonunu görüntüleme

Yeni bir WADL dosyası veya OpenAPI Spesifikasyonu içe aktararak bir modelin yeni revizyonunu oluşturuyorsunuz düzeltmeyi manuel olarak yapabilirsiniz. Yeni düzeltmeyi oluşturduktan sonra düzeltmeyi oluşturabilir ve yayınlayabilirsiniz. Bu, şu anda yayında olan Drupal düğümlerinin yerini alır.

Aynı anda birden fazla düzeltmeden düğüm oluşturabilir ve yayınlayabilirsiniz. Yani elinizde beş düzeltmesi varsa herhangi bir revizyondan veya tüm revizyonlardan düğüm yayınlayabilirsiniz. Ancak, yayınlama bir modelde bulunan ve başka bir modeldeki yayınlanan düğümle aynı olan API, daha eski bir modeldeki API'yi yayından kaldırır. API'nın sürümünü kullanıp onu en son yayınlanan sürümle değiştirir API'ye gidin.

Bir modelin düzeltmesini görmek için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Seç İçerik > SmartDokümanlar'ı kullanarak yönetiyorum.
  3. Güncellemek istediğiniz model için API Düzeltmeleri'ni seçin. İşlemler.
  4. Görüntülemek istediğiniz model düzeltmesini seçin.
  5. Düğümleri yukarıda açıklanan şekilde oluşturun ve yayınlayın.

Düğüm düzenleme

Bir düğümü oluşturduktan sonra Drupal düzenleyicisini kullanarak düzenleyebilirsiniz. Örneğin, Yeşil Ofis projenizde API'nin HTTP fiili ve açıklaması ya da API'ye yeni bir sorgu veya başlık parametresi eklemelidir. Siz bir WADL dosyasından veya OpenAPI Spesifikasyonundan oluşturulan düğümleri ya da manuel olarak ekleyin.

Ayrıca orijinal WADL dosyasını veya OpenAPI Spesifikasyonu'nu da düzenleyebilirsiniz. WADL dosyasını veya OpenAPI Spesifikasyonunu yeni bir düzeltme olarak modele geri ardından değişikliklerinizi yukarıda açıklandığı şekilde oluşturup yayınlayın.

Dupal düzenleyicisini kullanarak bir düğümü düzenlemek için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Eklemek istediğiniz API belgelerine karşılık gelen Drupal düğümüne gidin. düzenleyin.
  3. Drupal düzenleyiciyi kullanmak için Düzenle'yi seçin.
  4. Düzenlemeleriniz tamamlandıktan sonra Yöntemi Güncelle'yi seçin.

Alternatif olarak, düğümü SmartDokümanlar modelinden de düzenleyebilirsiniz:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. İçerik > SmartDokümanlar'ı kullanarak yönetiyorum.
  3. Güncellemek istediğiniz model için API Düzeltmeleri'ni seçin. İşlemler.
  4. Yayınlamak istediğiniz model düzeltmesini seçin.
  5. Şuna ait İşlemler açılır menüsünde Yöntemi düzenle'yi seçin: yöntemi seçin.

Bir düğümü silmek için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. İçerik > SmartDokümanlar'ı kullanarak yönetiyorum.
  3. Güncellemek istediğiniz model için API Düzeltmeleri'ni seçin. İşlemler.
  4. Yayınlamak istediğiniz model düzeltmesini seçin.
  5. Yöntemi sil'i seçin yöntemin İşlemler açılır listesini tıklayın.
    . Dikkat: Düğümü sildiğinizde API, modelden de kaldırılır. Yalnızca portal kullanıcılarından gizlenmesi için API'yi yayından kaldırmak istiyor ancak API'yi silmek istemiyorum modelinden, yukarıda açıklandığı gibi düğümü yayından kaldırmanız gerekir.

Portalda, bir API'nin oluşturduğu herhangi bir düğümle ilgili bilgileri SmartDokümanlar modeli, artık modelin geçerli yöntemlerinden birine başvurmaz. Rapora erişmek için şu yöntemi kullanın: Önce Drupal menüsünde Raporlar'ı, ardından raporu seçerek SmartDokümanlar düğüm durumu şeklinde adlandırılır.

Modelleri dışa ve içe aktarma

SmartDokümanlar mevcut bir modeli bir dosyaya aktarmanıza olanak sağlar. Örneğin, bir görevi tamamlamak için üretim ve hazırlık ortamı. Daha sonra tüm SmartDokümanlar düzenlemelerinizi hazırlık aşamasında yaparsınız bahsedeceğim. API'lerinizi yayınlamaya hazır olduğunuzda hazırlık modelini dışa aktarıp içe aktarırsınız. devreye sokmaktır.

Bir model içe aktarıldığında modelin yeni bir düzeltmesi oluşturulur. SmartDokümanlar mevcut öğeleri eşleştirmeye çalışır İçe aktarılan API'lere sahip modeldeki API'ler. SmartDokümanlar eşleşme algılarsa içe aktarma işlemi Drupal'ı günceller. düğümüne karşılık gelir. SmartDokümanlar eşleşme bulamazsa, içe aktarma API için yeni bir Drupal düğümü oluşturur.

Örneğin, kimliği 91 olan bir Drupal düğümüne karşılık gelen bir POST API'niz olduğunu varsayalım. Siz de bir model içe aktardığında, SmartDokümanlar içe aktarılan modeldeki bir POST API'sinin mevcut modelle eşleştiğini tespit ederse POST API'ye gidin. POST API'de yapılan güncellemeler ise Drupal düğümü 91'i günceller. SmartDokümanlar bir yeni bir kimlikle yeni bir Drupal düğümü oluşturur.

Drupal, eşleşmeyi API'nin aşağıdaki özelliklerini kullanarak gerçekleştirir:

  • internalName: Dahili model adı.
  • httpMethod: API'nin HTTP yöntemi. Örneğin: GET, PUT, POST veya SİL.
  • resourcePath: Kaynak yolu.
  • query params: API tarafından kullanılan tüm sorgu parametreleri.

İçe aktarılan bir API'nin dört özelliğinin tümü modeldeki mevcut bir API'yle eşleşirse SmartDokümanlar mevcut Drupal düğümünü günceller.

Dışa aktarılan model, kaynaklar ve ayarlar ile ilgili girişlere sahip tek bir JSON nesnesiyle yöntemlerine göz atın. Yani bir kaynağı veya yöntemi değiştirmek için dışa aktarılan modeli düzenleyebilir, daha sonra modeli tekrar içe aktarın. JSON nesnesini düzenlerseniz aşağıdaki alanları değiştirmeyin:

  • revisionNumber
  • createdTime
  • modifiedTime
  • apiRevisionId
  • resourceId

Bir modeli dışa aktarmak için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Seç İçerik > SmartDokümanlar'ı yönetiyorum.
  3. Dışa aktarmak istediğiniz model için Dışa aktar'ı seçin. İşlemler.
  4. Dışa aktarma dosya türünü SmartDokümanlar JSON olarak seçin.
  5. Dışa aktar'ı tıklayın.
  6. Dosyayı diske kaydetmeniz veya bir düzenleyicide açmanız istenir.

Bir modeli içe aktarmak için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Seç İçerik > SmartDokümanlar'ı yönetiyorum.
  3. İçe aktarmak istediğiniz model için İçe aktar'ı İşlemler.
  4. Select Format (Biçim Seç) açılır menüsünde SmartDokümanlar JSON'ı seçin.
  5. Dosya veya URL'yi seçin: Yükleme Türü:
    1. Dosya'yı seçerseniz JSON dosyasına göz atın.
    2. URL'yi seçerseniz SmartDokümanlar JSON dosyasının URL'sini belirtin.
  6. Etiketi modele aktarmak için İçe aktar'ı tıklayın.
  7. Modelin bilgi sayfasına yönlendirilirsiniz. Burada artık modeli. İçe aktarma işleminin, modelin yeni bir düzeltmesini oluşturduğunu unutmayın.
  8. Düğümleri oluşturma ve yayınlama

SmartDokümanlar şablonunu düzenleme

SmartDokümanlar şablonu, Drupal düğümlerinizin ekranda nasıl görüneceğini tanımlar. Her bir SmartDokümanlar bir şablonda kullanılan şablonu manuel olarak özelleştirebilirsiniz. için de geçerli.

SmartDokümanlar şablonu, Handlebars .hbr dosyası, CSS dosyaları, yardımcı olur. Tutamaçlar sayesinde içeriğin büyük kısmı, yerleşik özellikler kullanılarak değişkenlik odaklıdır. &123;&123;body}} gibi tutma çubuğu ifadeleri kullanabilirsiniz. Mevcut mevcut Gider çubuğu ifadeleri, dosyanın en üstündeki yorumlarda sağlanır. Daha fazla bilgi için Tutamaçları kullanarak şablonlarınızı özelleştirmek için http://handlebarsjs.com adresini ziyaret edin.

Aşağıdaki bölümlerde, herkesin kullanması için özel bir SmartDokümanlar şablon dosyasının nasıl yükleneceği açıklanmaktadır mevcut bir modele yeni API'leri içe aktarırken yeni API'leri nasıl geri ve bir dosya için SmartDokümanlar şablonunun nasıl değiştirileceği için de geçerli.

Özel bir SmartDokümanlar şablon dosyası

Google Dokümanlar için Gidon çubuğu .hbr dosyası olarak kullanmak üzere varsayılan şablonu kullanır.

Oluşturma işlemi sırasında başlangıç noktası olarak varsayılan SmartDokümanlar şablon dosyasını özel SmartDokümanlar şablon dosyanıza giderek bir kopyasını şu adresten indirebilirsiniz: profiles/apigee/modules/custom/devconnect/smartdocs/templates/smartdocs.hbr.

Özel SmartDokümanlar şablon dosyası yüklemek için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Yapılandırma > Drupal'daki SmartDokümanlar yönetim menüsü.
  3. Sayfanın Gelişmiş Ayarlar alanını genişletin.
  4. Özelleştirilmiş yöntem şablonu yükleyin altında Dosya Seç'i tıklayın ve Gidon çubukları .hbr dosyasına gidin.
  5. Yükle'yi tıklayın.
  6. Yapılandırmayı kaydet'i tıklayın.

varsayılan SmartDokümanlar şablon dosyası

Varsayılan SmartDokümanlar şablon dosyasını geri yükleyebilirsiniz. Geri yüklendikten sonra varsayılan SmartDokümanlar şablon dosyası, yeni modeller oluştururken veya yeni API'leri mevcut bir modeli.

Varsayılan SmartDokümanlar şablon dosyasını geri yüklemek için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Yapılandırma > Drupal'daki SmartDokümanlar yönetim menüsü.
  3. Sayfanın Gelişmiş Ayarlar alanını genişletin.
  4. Özelleştirilmiş yöntem şablonu yükleyin altında, özel SmartDokümanlar şablon dosyası.
  5. Yapılandırmayı kaydet'i tıklayın.

Değiştiriliyor bağımsız bir model için SmartDokümanlar şablonu

Tek bir model için kullanılan şablonu değiştirebilirsiniz.

Bağımsız bir modelin şablonunu değiştirmek için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. Seç İçerik > SmartDokümanlar'ı yönetiyorum.
  3. Düzenlemek istediğiniz model için şunun altında Ayarlar'ı seçin: İşlemler.
  4. Yöntem Şablonu alanında şablonu gerektiği gibi düzenleyin.
  5. Şablonu kaydet'i tıklayın.
  6. Bir Drupal düğümüne göz atın. Şablon değişikliklerinizi sayfada görmeniz gerekir.

SmartDokümanlar kimlik doğrulama türü

SmartDokümanlar'da tanımlanan API'ler açık olabilir, yani kimlik doğrulama kimlik bilgileri gerekmez veya güvenliklerini sağlamalısınız. Güvenli bir API, bir API'ye yapılan bir çağrıdır.

SmartDokümanlar güvenli bir API için aşağıdaki kimlik doğrulama türlerini destekler:

  • Temel kimlik doğrulama: Temel kimlik doğrulama bilgilerini Kullanıcı adı ve şifre çifti. Kimlik bilgisi türü olarak OAuth kullanımını belirtmezseniz API varsayılan olarak temel kimlik doğrulamasını kullanır.
  • OAuth 2.0: Üçüncü taraf bir servis sağlayıcı, kullanıcının kimlik bilgilerini içerir, kullanıcının API'ye erişim yetkisi olduğundan emin olur ve ardından jeton. Korunan bir API'ye Smart Docs isteğinde bulunduğunuzda SmartDokümanlar isteği oluşturur ve hizmet sağlayıcıya gönderir. Daha sonra servis sağlayıcı jetonu doğrular ve geçerliliğini yitirmiş olmalıdır.
  • Özel jeton - Anahtarların her birine başlık veya sorgu parametresi olarak bir jeton değeri iletin isteğinde bulunabilirsiniz.

Her kimlik doğrulama türü için kimlik doğrulamanın özelliklerini kullanın. Örneğin, özel jeton kimlik doğrulaması için güvenlik şeması, jetonun nasıl geçirildiğini (başlık, sorgu parametresi, gövde parametresi) ve jetonun adını jeton.

Güvenlik şeması, bir modelin belirli bir düzeltmesiyle ilişkilendirilir. Dolayısıyla, bu revizyona ilişkin güvenlik şemalarını yeniden tanımlamanız gerekir

Bir WADL dosyasında, bir API'nin kimlik doğrulama gerektirip gerektirmediğini, aşağıdaki gibi &lt;apigee:authentication&gt; Apigee etiketini kullanarak aşağıda gösterilmiştir:

<method id="statusespublic_timeline" name="GET" apigee:displayName="PublicTimeline">
    ...
    <apigee:authentication required="true"/>
</method>

API açıksa zorunlu özelliği için false değerini ayarlayın.

WADL dosyasında kimlik doğrulama türünü belirtemeyeceğinizi unutmayın. Bu işlemi gerçekleştirmek için düğümünü Drupal'da düzenliyoruz. WADL dosyaları hakkında daha fazla bilgi için bkz. WADL Referans.

SmartDokümanlar, Drupal'daki API sayfasında kullanıcıların temel kimlik doğrulama bilgileri:

Düğümü, kimlik doğrulama türünü OAuth olarak ayarlayacak şekilde düzenlerseniz SmartDokümanlar aşağıdaki düğmeyi kullanın:

SmartDokümanlar özel jeton için şunları ekler:

Yapılandırılıyor temel kimlik doğrulama

API'nızla temel kimlik doğrulamasını kullanıyorsanız WADL'de yalnızca &lt;apigee:authentication&gt; etiketini belirtmeniz gerekir dosyasını seçin.

WADL dosyası dışındaki bir kaynaktan oluşturulan yöntemlere temel kimlik doğrulaması uygulamak için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. İçerik > SmartDokümanlar'ı yönetiyorum.
  3. İstediğiniz model için API Revisions (API Düzeltmeleri) seçeneğini belirleyin. İşlemler.
  4. Düzenlemek istediğiniz model düzeltmesi için Güvenlik Ayarlar'ı (İşlemler) tıklayın.
  5. Güvenlik Şeması Ekle'yi seçin.
  6. Güvenlik şemasının adını belirtin.
  7. Tür olarak Temel'i seçin.
  8. Gönder'i seçin.
  9. Modeldeki her yöntem için Güvenlik Şeması'nı ayarlamak üzere yöntemi düzenleyin. şemanıza entegre edebilirsiniz.
    1. İçerik > SmartDokümanlar'ı yönetiyorum.
    2. İstediğiniz model için API Revisions (API Düzeltmeleri) seçeneğini belirleyin. İşlemler.
    3. Düzenlemek istediğiniz model düzeltmesi için Düzeltme İşlemler başlığının altındaki ayrıntılar.
    4. Düzenlemek istediğiniz API için Yöntemi Düzenle'yi seçin.
    5. API'nin Güvenlik Şeması'nı seçin.
    6. API'yi kaydedin.

Yapılandırılıyor OAuth 2.0 kimlik doğrulaması

SmartDokümanlar'da, varsayılan temel model yerine OAuth 2.0'ı kullanacak şekilde bir model yapılandırabilirsiniz. kimlik doğrulama. OAuth'u iki konumda yapılandırırsınız:

  1. Güvenlik altında bir modelin her revizyonu için bir güvenlik şeması oluşturun Düzeltmenin ayarları
  2. Modelin tüm revizyonları için İstemci Kimliği'ni ve İstemci Sırrını Modelin ayarları.
ziyaret edin.

OAuth'u etkinleştirmek için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. İçerik > SmartDokümanlar'ı yönetiyorum.
  3. İstenen model için İşlemler bölümünde API Düzeltmeleri'ni seçin.
  4. Düzenlemek istediğiniz model düzeltmesi için Güvenlik Ayarları öğesini İşlemler.
  5. Güvenlik Şeması Ekle'yi seçin.
  6. Güvenlik şemasının adını belirtin.
  7. Type (Tür) olarak OAuth 2.0'ı seçin.
  8. İzin Türü'nü ayarlayın.
  9. Değerleri Yetkilendirme URL'si alanlarına girin. Yetkilendirme URL, erişim jetonunu almak için kullanılır.
  10. Yetkilendirme Fiili'ni GET veya POST olarak ayarlayın.
  11. Access Token URL (Erişim Jetonu URL'si) değerini girin. Erişim Jetonu URL'si, istek jetonunu bir erişim jetonuyla değiştirin.
  12. Erişim Jetonu parametre adını girin.
  13. Jetonun nasıl iletileceğini belirtmek için In (İçinde) seçeneğini kullanın: Header (Başlık), Query veya Body.
  14. OAuth Kapsamları'nı ayarlayın.
  15. Gönder'i seçin.
  16. İçerik > SmartDokümanlar'ı yönetiyorum.
  17. Model için İşlemler bölümünde Ayarlar'ı seçin. açılır.
  18. Değerleri İstemci Kimliği ve Client Gizli.
  19. Şablon kimlik doğrulama ayarlarını kaydet'i seçin.
  20. Modeldeki her yöntem için Güvenlik Şeması'nı ayarlamak üzere yöntemi düzenleyin. OAuth güvenlik şemanıza göre ekleyebilirsiniz.
    1. İçerik > SmartDokümanlar'ı yönetiyorum.
    2. İstediğiniz model için API Revisions (API Düzeltmeleri) seçeneğini belirleyin. İşlemler.
    3. Düzenlemek istediğiniz model düzeltmesi için Düzeltme İşlemler başlığının altındaki ayrıntılar.
    4. Düzenlemek istediğiniz API için Yöntemi Düzenle'yi seçin.
    5. API'nin Güvenlik Şeması'nı seçin.
    6. API'yi kaydedin.

Özel jeton kimlik doğrulamasını yapılandırma

Bir modeli, özel jeton kimlik doğrulamasını kullanacak şekilde yapılandırabilirsiniz.

Özel jetonları etkinleştirmek için:

  1. Portalınıza, yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
  2. İçerik > SmartDokümanlar'ı yönetiyorum.
  3. İstediğiniz model için API Revisions (API Düzeltmeleri) seçeneğini belirleyin. İşlemler.
  4. Düzenlemek istediğiniz model düzeltmesi için Güvenlik Ayarlar'ı (İşlemler) tıklayın.
  5. Güvenlik Şeması Ekle'yi seçin.
  6. Güvenlik şemasının adını belirtin.
  7. Tür olarak Apikey'i seçin.
  8. Jetonu içeren Param Adını belirleyin.
  9. Ödevin nasıl geçileceğini belirtmek için In (içinde) ifadesini kullanın. jeton: Başlık, Sorgu, veya Gövde.
  10. Gönder'i seçin.
  11. Modeldeki her yöntem için Güvenlik Şeması'nı ayarlamak üzere yöntemi düzenleyin. jeton şemanıza göre ekleyebilirsiniz.
    1. İçerik > SmartDokümanlar'ı yönetiyorum.
    2. İstediğiniz model için API Revisions (API Düzeltmeleri) seçeneğini belirleyin. İşlemler.
    3. Düzenlemek istediğiniz model düzeltmesi için Düzeltme İşlemler başlığının altındaki ayrıntılar.
    4. Düzenlemek istediğiniz API için Yöntemi Düzenle'yi seçin.
    5. API'nin Güvenlik Şeması'nı seçin.
    6. API'yi kaydedin.

Model silme

Bir modeli sildiğinizde (İçerik > SmartDokümanlar, Sil İşlemler alanına dokunduğunuzda) model, Edge kuruluşunuzdan silinir. Yani, projenizin diğer portallar modele referans veriyorsa model artık kullanılamıyor. Daha fazla bilgi için SmartDoc modelleri ve şablonları hakkında konusuna bakın.