Geliştirme araçları

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Servis sağlayıcı olarak istemci uygulamalarının kullanımına yönelik API'ler geliştiriyorsunuz. API proxy'leri ve API ürünleri oluşturmak, yapılandırmak ve sürdürmek için kullanıcı arayüzünü kullanabilir veya aşağıdaki bölümlerde açıklandığı gibi RESTful hizmetlere erişmek için API'lere HTTP istekleri gönderebilirsiniz.

Edge kullanıcı arayüzünü kullanma

Apigee Edge kullanıcı arayüzü; API proxy'leri ve API ürünleri oluşturmak, yapılandırmak ve yönetmek için kullanabileceğiniz tarayıcı tabanlı bir araçtır. Görevlerin bir alt kümesi de yalnızca API kullanılarak gerçekleştirilebilir.

Aşağıdaki tabloda, Edge kullanıcı arayüzüne nasıl erişileceği açıklanmaktadır:

Ürün Kullanıcı Arayüzü Adı Erişim URL'si
Edge Edge kullanıcı arayüzü

Edge kullanıcı arayüzüne erişmek için aşağıdaki URL'yi kullanın:

https://apigee.com/edge

Edge kullanıcı arayüzünü kullanma hakkında bir eğitim için İlk API proxy'nizi oluşturma bölümüne bakın.
Private Cloud için Edge Klasik Edge kullanıcı arayüzü

Edge for Private Cloud'un Edge kullanıcı arayüzüne erişmek için aşağıdaki URL'yi kullanın:

http://ms-ip:9000

Burada ms-ip, Yönetim Sunucusu düğümünün IP adresi veya DNS adıdır.

Edge kullanıcı arayüzünü kullanarak şunları yapabilirsiniz:

  • Kodu düzenleyerek ve proxy'lerinizden istek akışlarını izleyerek API proxy'leri oluşturun.
  • İstemci istekleriyle karşılaşma için proxy'leri paketleyen API ürünleri oluşturun.
  • Geliştiricileri ve geliştirici uygulamalarını yönetin.
  • Test ve üretim ortamlarınızı yapılandırın.
  • JavaScript ve Node.js uygulamalarını uygulayın.

Aşağıdaki resimde, kullanıcı arayüzünde API proxy'si oluşturmak ve yapılandırmak için kullanabileceğiniz API proxy düzenleyicisi gösterilmektedir:

Edge kullanıcı arayüzündeki API proxy düzenleyicisinde seçilen Geliştir sekmesini gösterir.

Edge API'yi kullanma

API kaynaklarınızı yönetmek için Edge API'yi kullanabilirsiniz. API'ler, kullanıcı arayüzü tarafından sunulmayan alt düzey özelliklere erişim de sağlar.

API uç noktaları genellikle yapılandırma bilgilerini içeren verileri alır ve bunlara erişmek için kullanıcı adı ve şifre gibi kimlik doğrulama bilgilerini iletmenizi gerektirir. RESTful ilkelerine uygun şekilde, API kaynaklarının herhangi birinde HTTP GET, POST, PUT ve DELETE yöntemlerini çağırabilirsiniz.

Apigee Edge API'lerin tam listesi için Apigee Edge API Referansı'na bakın.

Edge API temel yolunu anlama

API isteklerinde kullanacağınız yol aşağıdakileri birleştirir:

  • Kuruluşunuzun adını içeren bir temel yol. Örneğin: https://api.enterprise.apigee.com/v1/organizations/org_name
  • Erişmekte olduğunuz Edge kaynağına işaret eden bir uç nokta.

Örneğin, kuruluşunuzun adı apibuilders ise API'ye yaptığınız her çağrı aşağıdaki temel yolu kullanır:

https://api.enterprise.apigee.com/v1/organizations/apibuilders

Kuruluşunuzdaki API proxy'lerinin listesini almak için şurada GET işlevini kullanırsınız:

https://api.enterprise.apigee.com/v1/organizations/apibuilders/apis

Birçok kaynak ortama göre belirlenir. Varsayılan olarak iki ortam sağlanır: test ve üretim. Örneğin, önbellekler ortama göre belirlenir. Her ortama varsayılan olarak "mycache" adı verilen paylaşılan bir önbellek dahil edilir.

Önbellek kaynağında GET yöntemini aşağıdaki şekilde çağırarak önbellekleri listeleyebilirsiniz:

https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/test/caches
https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/prod/caches

Erişim kimliğini doğrulama

API'leri çağırırken API sunucusunda kimliğinizi doğrulamanız gerekir. Bunu aşağıdaki yöntemlerden birini kullanarak yapabilirsiniz:

Apigee, ayrıca Apigee hesabınız için iki faktörlü kimlik doğrulamayı etkinleştirme bölümünde açıklandığı gibi iki faktörlü kimlik doğrulama kullanmanızı önerir.

Edge API sınırları

Her kuruluş aşağıdaki Edge API çağrı ücretleriyle sınırlıdır:

  • Ücretli plan kullanan kuruluşlar için dakikada 10.000 çağrı
  • Deneme sürümü kuruluşları için dakikada 600 çağrı

401 ve 403 HTTP durum kodları bu sınıra dahil değildir. Bu sınırları aşan tüm çağrılar, 429 Too Many Requests durum kodu döndürür.

Edge API'leriyle çalışma ipuçları

Bu bölümde, Edge API'leriyle çalışmayı kolaylaştıran bazı teknikler açıklanmaktadır.

Talep URL'lerini kısaltma

Edge API'lerine yönelik istek URL'nizi oluşturduğunuzda aşağıdaki kısaltmaları kullanabilirsiniz:

  • /e = /environments
  • /o = /organizations
  • /r = /revisions

Kısaltmalar kullanıyorsanız bunları tutarlı bir şekilde kullanmanız gerekir. Yani, yukarıda belirtildiği ve aşağıdaki örnekte gösterildiği gibi yoldaki tüm öğeleri kısaltın veya hiç kısaltmayın. Hem tam hem de kısaltılmış öğelerin aynı yolda kullanılması hataya neden olur.

Örneğin:

THIS:
https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/environments/prod/apis/helloworld/revisions/1/deployments
CAN BE MUCH SHORTER:
https://api.enterprise.apigee.com/v1/o/ahamilton-eval/e/prod/apis/helloworld/r/1/deployments

Curl komutlarını çalıştırma

API'ye istek göndermek için HTTP istemcisi kullanma. Belgelerdeki birçok örnekte, yaygın olarak kullanılan bir HTTP istemcisi olan curl'nin kullanıldığı örnek API istekleri sağlanmaktadır. curl uygulamasını yüklemeniz gerekiyorsa uygulamayı http://curl.haxx.se adresinden indirebilirsiniz.

Yanıtlarda gzip sıkıştırması için API'ye yapılan çağrılar. API çağrılarınızda 'Accept-Encoding: gzip, deflate' değerini ayarlarsanız 1.024 bayttan büyük tüm yanıtlar gzip biçiminde döndürülür.

XML ve JSON isteklerini ve yanıtlarını biçimlendirme

Edge API, verileri varsayılan olarak JSON biçiminde döndürür. Birçok istek için yanıtın XML olarak geri gönderilmesini sağlayabilirsiniz. Bunun için Accept istek başlığını, aşağıdaki örnekte gösterildiği gibi application/xml olarak ayarlayın:

curl -H "Authorization: Bearer `get_token`" \
  -H "Accept: application/xml" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \
  | xmllint --format -

Yanıt aşağıdaki gibi görünmelidir:

<List>
  <Item>SOAP-Message-Validation-1</Item>
  <Item>Spike-Arrest-1</Item>
  <Item>XML-to-JSON-1</Item>
</List>

Bu örneğin, sonuçları görüntülemek için yanıtı xmllint üzerinden bağlayarak prettyprint kullandığını unutmayın.

acurl yardımcı programı Accept üstbilgisini desteklemiyor. Bu nedenle, acurl ile yalnızca JSON biçimli yanıtlar alabilirsiniz.

JSON yanıtı olarak prettyprint kullanmak için json.tool Python kitaplığını kullanabilirsiniz:

curl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer `get_token`" \
  | python -m json.tool

Aşağıda yanıtla ilgili bir örnek yer almaktadır:

[
  "SOAP-Message-Validation-1",
  "Spike-Arrest-1",
  "XML-to-JSON-1"
]

XML için xmllint kullanabilirsiniz:

curl https://ahamilton-eval-test.apigee.net/getstarted -u email_address | xmllint --format -

Yükleri XML'de YAYINLAMA veya PUT eklerken Content-type HTTP başlığını kullanın:

acurl -H "Content-type:text/xml" -X POST -d \
'<XMLPayload>
 </XMLPayload> ' \
https://api.enterprise.apigee.com/v1/organizations/apifactory/apis -u email_address

Dağıtım ortamları

Varsayılan olarak Apigee Edge'i kullanan her kuruluş, API'leri geliştirmek, test etmek ve dağıtmak için kullanabilecekleri en az iki ortama sahiptir: "test" ve "prod". API'lerinizi herkese açık hale getirmeden önce geliştirip test etmek için "test" ortamını kullanın. Test ortamına dağıtılan API'lere yalnızca dahili geliştiricileriniz erişebilir. API'lerinizi uygulama geliştiricilerinin kullanımına açık hale getirmek için "üretim" ortamına dağıtın.

Hata ayıklama ve test etme

Apigee, uçtan uca istek ve yanıt akışlarında hata ayıklamanızı sağlayan bir izleme aracı sunar. İzleme sonuçları; istek ve yanıt üstbilgileri ile yüklerini, politika yürütmesini, değişken değerlerini ve akış sırasında oluşabilecek hataları gösterir.

Sorun gidermede kullanılacak önemli veri noktaları:

  • Zaman damgaları: Her bir adımın ne kadar sürdüğünü görmek için zaman damgalarını kullanın. Zaman damgalarını karşılaştırmak, API çağrılarınızı yavaşlatan ve yürütülmesi en uzun süren politikaları belirlemenize yardımcı olur.
  • Temel yol: Temel yolu doğrulayarak bir politikanın iletiyi doğru sunucuya yönlendirdiğinden emin olabilirsiniz.
  • Politika yürütmenin sonuçları: Bu sonuçlar, mesajın beklendiği gibi değiştirilip değiştirilmediğini (ör. mesajın XML'den JSON'a dönüştürülüp dönüştürülmediğini veya önbelleğe alınıp alınmadığını) görmenizi sağlar.

Aşağıdaki şekilde iz sonuçları gösterilmektedir:

Edge kullanıcı arayüzündeki API proxy düzenleyicisinde seçilen İzleme sekmesini gösterir.

Her İzleme oturumu aşağıdaki ana adımlara bölünür:

  • İstemciden alınan orijinal istek: İsteğin istemci uygulamasından, başlıklardan, gövde verilerinden ve sorgu parametrelerinden gelen fiili ve URI yolunu gösterir.
  • İstek arka uç hizmetinize gönderildi: API proxy'si tarafından arka uç hizmetine gönderilen istek mesajını gösterir.
  • Arka uç hizmeti tarafından döndürülen yanıt: Arka uç hizmeti tarafından döndürülen yanıt başlıklarını ve yükü görüntüler.
  • İstemciye gönderilen son yanıt: Yanıt akışı yürütüldükten sonra, istekte bulunan istemci uygulamasına döndürülen yanıt mesajı.