OpenAPI Şartnamesinden API proxy'si oluşturma | Apigee Edge

Bu eğiticide, OpenAPI'den Edge API proxy'si oluşturmayı öğreneceksiniz. Apigee Edge yönetim kullanıcı arayüzünü kullanan spesifikasyonlar. API proxy'sini cURL gibi bir HTTP istemcisi olduğunda API proxy'si, isteği Apigee örnek hedefine gönderir geliştirmenizi sağlar.

Open API Initiative hakkında

"Open API Initiative (OAI) şuna odaklanıyor: Swagger'a dayalı tedarikçiden bağımsız bir API Açıklama Biçimi oluşturmak, geliştirmek ve tanıtmak Teknik Özellikleri'ne tabidir." Open API Initiative hakkında daha fazla bilgi için https://openapis.org adresini ziyaret edin.

OpenAPI Spesifikasyonu, RESTful API'yi tanımlamak için standart bir biçim kullanır. JSON veya YAML biçiminde yazılan OpenAPI Spesifikasyonu makine tarafından okunabilir ancak okuması ve anlaması kolay bir hale geldi. Bu spesifikasyonda, bir temel yolu, yolları ve fiilleri, başlıkları, sorgu parametreleri, işlemleri, içerik türleri, ve daha fazlası. Ayrıca OpenAPI Spesifikasyonu yaygın olarak kullanılan API belgeleri oluşturabilirsiniz.

Apigee sahte hedef hizmeti hakkında

Bu eğitimde kullanılan Apigee sahte hedef hizmeti, Apigee'de barındırılır ve basit verilerdir. API anahtarı veya erişim jetonu gerektirmez. Hatta web'den de erişebilirsiniz. emin olun. Aşağıdakileri tıklayarak deneyin:

http://mocktarget.apigee.net

Hedef hizmet, Hello, guest! karşılama mesajını döndürür

Sahte hedef hizmetin desteklediği tüm API'ler hakkında bilgi edinmek için takip etmek için:

http://mocktarget.apigee.net/help

Gerekenler

Bir Apigee Edge hesabı. Hesabınız yoksa şu yönergeleri izleyerek kaydolabilirsiniz: Apigee Edge Oluşturma hesap.
Bir OpenAPI Spesifikasyonu. Bu eğitimde mocktarget.yaml'ı kullanacaksınız Apigee'nin örnek hedefini açıklayan OpenAPI Specification hizmet, http://mocktarget.apigee.net. Daha fazla bilgi için bkz. https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi
API çağrıları yapmak için makinenizde cURL yüklüdür komut satırından; veya web tarayıcısı.

API proxy'sini oluşturma

Edge

Edge kullanıcı arayüzünü kullanarak OpenAPI Spesifikasyonundan API proxy'si oluşturmak için:

https://apigee.com/edge adresinde oturum açın.
Ana pencerede API Proxy'leri seçeneğini tıklayın.
Alternatif olarak Geliştir > API Proxy'leri bölümüne gidin.
+ Proxy'yi tıklayın.
Create Proxy sihirbazında, Ters proxy (en yaygın) şablonu için Use OpenAPI Spec (OpenAPI Spesifikasyonunu Kullan) seçeneğini tıklayın.
URL'den içe aktar'ı tıklayın ve aşağıdaki bilgileri girin:
- OpenAPI Spesifikasyon URL'si: URL alanındaki OpenAPI Spesifikasyonu için GitHub'daki ham içeriğin yolu:
```
https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
```
- Spesifikasyon adı: OpenAPI Spesifikasyonu için Örnek Hedef gibi bir ad.
  Bu ad, OpenAPI Spesifikasyonu'nu spesifikasyon deposunda depolamak için kullanılır. Spesifikasyonlarınızı yönetme başlıklı makaleyi inceleyin.

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

Proxy Oluşturma sihirbazının Ayrıntılar sayfası görüntülenir. Alanlar önceden doldurulmuş aşağıda gösterildiği gibi, OpenAPI Spesifikasyonu'nda tanımlanan değerleri kullanarak

Aşağıdaki tabloda, özellikleri hakkında daha fazla bilgi edinin. OpenAPI Spesifikasyonu'ndan bir alıntı tablonun altında, kullanılan özelliklerin gösterimi gösterilmektedir.

Alan	Açıklama	Varsayılan
Ad	API proxy'sinin adı. Örnek: `Mock-Target-API`.	OpenAPI Spesifikasyonu'ndan boşluklar değiştirilmiş `title` mülkü kısa çizgiyle
Temel yol	Kuruluş içinde bu API proxy'sini benzersiz şekilde tanımlayan yol bileşeni. Bu API proxy'sinin herkese açık URL'si, kuruluşunuzun adı, ortamını ve bu temel yolu kontrol edin. Örneğin, örnek: `http://myorg-test.apigee.net/mock-target-api`	Ad alanının içeriği tamamı küçük harfe dönüştürüldü
Açıklama	API proxy'sinin açıklaması.	OpenAPI Spesifikasyonu'ndan `description` mülkü
Hedef (Mevcut API)	Hedef URL bu API proxy'si adına çağrıldı. Şu üzerinden erişilebilen herhangi bir URL: açık internet kullanılabilir. Örnek: `http://mocktarget.apigee.net`.	OpenAPI Spesifikasyonu'ndan `servers` mülkü

Aşağıda, OpenAPI Spesifikasyonu'ndan alanları önceden doldurmak için kullanılır.

openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
...
servers:
  - url: http://mocktarget.apigee.net
  - url: https://mocktarget.apigee.net
...

Açıklama alanını şu şekilde düzenleyin: API proxy for the Apigee mock target service endpoint.
İleri'yi tıklayın.
Ortak politikalar sayfasında, Güvenlik: Yetkilendirme altında Geçiş (yetkilendirme yok) seçeneğinin belirlendiğinden emin olun ve İleri'yi tıklayın:
Akışlar sayfasında tüm işlemlerin seçili olduğundan emin olun.
İpucu: Koşullu akışlar OpenAPI'deki paths nesnesinde tanımlanan işlemler Spesifikasyon. Koşullu akışlar, Edge'e "Bunu gördüğünüzde bu mantığı gerçekleştir" ifadesini verir. Örneğin, bir API çağrısı /xml kaynağında (koşul) bir GET olduğunda, yanıtı JSON'a dönüştürür (koşullu akışa ekli bir politika aracılığıyla). Yalnızca işlem başına bir akış yürütülür; koşulu şu şekilde değerlendirilen ilk akış: içerir.
İleri'yi tıklayın.
Sanal ana makineler sayfasında varsayılan ve güvenli'yi seçip Sonraki'ye dokunun.
Özet sayfasında Test ortamının Optional Deployment (İsteğe Bağlı Dağıtım) öğesini seçin ve Create and deploy:

Apigee, yeni API proxy'nizi oluşturur ve test ortamınıza dağıtır:
API'nin Genel Bakış sayfasını görüntülemek için Proxy'yi düzenle'yi tıklayın temsil eder.

Klasik Edge (Private Cloud)

Klasik Uç Kullanıcı Arayüzünü kullanarak OpenAPI Spesifikasyonundan API proxy'si oluşturmak için:

https://apigee.com/edge adresinde oturum açın.
Ana pencerede API Proxy'leri seçeneğini tıklayın.
Alternatif olarak Geliştir > API Proxy'leri bölümüne gidin.
+ Proxy'yi tıklayın.
Proxy Oluştur sihirbazında, Ters proxy (en yaygın) seçeneğini belirleyin ve Use OpenAPI'yi (OpenAPI'yi Kullan) tıklayın.
Import from a URL (URL'den içe aktar) seçeneğini tıklayın, OpenAPI Specification için bir ad girin ve OpenAPI için GitHub'daki ham içeriğin yolunu girin. URL alanında spesifikasyon:

https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml
Seç'i tıklayın.

İleri'yi tıklayın.

Proxy Oluşturma sihirbazının Ayrıntılar sayfası görüntülenir. Alanlar önceden doldurulmuş aşağıda gösterildiği gibi, OpenAPI Spesifikasyonu'nda tanımlanan değerleri kullanarak figür.

Aşağıdaki tabloda, özellikleri hakkında daha fazla bilgi edinin. OpenAPI Spesifikasyonu'ndan bir alıntı tablonun altında, kullanılan özelliklerin gösterimi gösterilmektedir.

Alan	Açıklama	Varsayılan
Proxy Adı	API proxy'sinin adı. Örnek: `Mock-Target-API`.	OpenAPI Spesifikasyonu'ndan boşluklar değiştirilmiş `title` mülkü kısa çizgiyle
Proxy Temel Yolu	Kuruluş içinde bu API proxy'sini benzersiz şekilde tanımlayan yol bileşeni. Bu API proxy'sinin herkese açık URL'si, kuruluşunuzun adı, ortamını ve bu temel yolu kontrol edin. Örneğin, örnek: `http://myorg-test.apigee.net/mock-target-api`	Ad alanının içeriği tamamı küçük harfe dönüştürüldü
Mevcut API	Bu API proxy'si adına çağrılan hedef URL. Şu üzerinden erişilebilen herhangi bir URL: açık internet kullanılabilir. Örnek: `http://mocktarget.apigee.net`.	OpenAPI Spesifikasyonu'ndan `servers` mülkü
Açıklama	API proxy'sinin açıklaması.	OpenAPI Spesifikasyonu'ndan `description` mülkü

Aşağıda, OpenAPI Spesifikasyonu'ndan alanları önceden doldurmak için kullanılır.

openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
...
servers:
  - url: http://mocktarget.apigee.net
  - url: https://mocktarget.apigee.net
...

Açıklama alanını şu şekilde düzenleyin: API proxy for the Apigee mock target service endpoint.
İleri'yi tıklayın.
Akışlar sayfasında tüm işlemlerin seçili olduğundan emin olun.
İpucu: Koşullu akışlar OpenAPI'deki paths nesnesinde tanımlanan işlemler Spesifikasyon. Koşullu akışlar, Edge'e "Bunu gördüğünüzde bu mantığı gerçekleştir" ifadesini verir. Örneğin, bir API çağrısı /xml kaynağında (koşul) bir GET olduğunda, yanıtı JSON'a dönüştürür (koşullu akışa ekli bir politika aracılığıyla). Yalnızca işlem başına bir akış yürütülür; koşulu şu şekilde değerlendirilen ilk akış: içerir.
İleri'yi tıklayın.
Güvenlik sayfasında, güvenlik ayarı olarak Geçiş (yok) seçeneğini belirleyin seçeneğini belirtin ve İleri'yi tıklayın.
Virtual Hosts (Sanal Ana Makineler) sayfasında tüm sanal ana makinelerin seçili olduğundan emin olun ve Sonraki'ye dokunun.
Derleme sayfasında test ortamının seçili olduğundan emin olun ve Build and Deploy'u (Derleme ve Dağıt) tıklayın.
Özet sayfasında yeni API proxy'nizin oluşturulduğuna dair bir onay görürsünüz ve test ortamınıza dağıtılmasını sağlayabilirsiniz.
API'nin Genel bakış sayfasını görüntülemek için Mock-Target-API'yi tıklayın. temsil eder.

Tebrikler! OpenAPI Specification'dan API proxy'si oluşturdunuz. Ardından, nasıl çalıştığını görmek için test edin.

API proxy'sini test etme

Mock-Target-API API'nizi cURL veya bir web tarayıcısı kullanarak test edebilirsiniz.

Bir terminal penceresinde aşağıdaki cURL komutunu çalıştırın. Kuruluş adınızı URL'yi girin.

curl http://<org_name>-test.apigee.net/mock-target-api

Yanıt

Aşağıdaki yanıtı göreceksiniz:

Hello, Guest!

Tebrikler! OpenAPI Spesifikasyonu'ndan basit bir API proxy'si derlediniz ve somut olarak ortaya koyar.

JSON politikasına XML ekleme

Ardından, XML'den JSON politikasını XML Yanıtını Görüntüle bölümüne ekleyeceksiniz. API proxy'sini OpenAPI Spesifikasyonu. Politika, hedefin XML yanıtını bir JSON dosyasına dönüştürür tıklayın.

Öncelikle API'yi çağırın. Böylece, eklediğiniz sonuçlarla sonuçları karşılaştırabilirsiniz politika. Bir terminal penceresinde aşağıdaki cURL komutunu yürütün. hedef hizmetin /xml kaynağıdır. Bu kaynak, yerel olarak basit bir XML bloğunu döndürür. URL'de kuruluşunuzun adını girin.

curl http://<org_name>-test.apigee.net/mock-target-api/xml

Yanıt

Aşağıdaki yanıtı göreceksiniz:

<root> 
  <city>San Jose</city> 
  <firstName>John</firstName> 
  <lastName>Doe</lastName> 
  <state>CA</state> 
</root>

Şimdi XML yanıtını JSON'a dönüştüren bir şey yapalım. XML'i JSON politikasına ekleme API proxy'sindeki XML Yanıtını Görüntüleyin koşullu akışına geçmelidir.

Mock-Target-API'nin sağ üst köşesindeki Develop sekmesini tıklayın. Edge kullanıcı arayüzündeki genel bakış sayfası.
Soldaki gezinme bölmesinde, Proxy Endpoints altında > Varsayılan ayar olarak Görünüm XML Yanıtı koşullu akışıdır.
Ekranın alt kısmındaki +Adım düğmesini, Akışla ilgili yanıt.
.
Adım Ekle iletişim kutusu açılır ve uygulayabileceğiniz tüm politikaların kategorilere ayrılmış bir listesini gösterir ekle.
Uyumlulaştırma kategorisine ilerleyin ve XML'den JSON'ye seçeneğini belirleyin.
Görünen Ad ve Ad.
Ekle'yi tıklayın. XML'den JSON'ye politikası, yanıta uygulanır.
Kaydet'i tıklayın.

Politikayı eklediğinize göre cURL'yi kullanarak API'yi tekrar çağırın. Hâlâ aynı /xml kaynağına çağrılıyor. Hedef hizmet hâlâ XML biçiminde, ancak artık API proxy'sindeki politika, yanıtı JSON biçimine dönüştürür. Bunu yap arayın:

curl http://<org_name>-test.apigee.net/mock-target-api/xml

XML yanıtının JSON'a dönüştürüldüğünü unutmayın:

{"root":{"city":"San Jose","firstName":"John","lastName":"Doe","state":"CA"}}

Tebrikler! koşullu akışın bir parçasıdır.