Geliştirme araçları

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

Bir servis sağlayıcı olarak, istemci uygulamaları tarafından kullanılmak üzere API'ler geliştirirsiniz. API proxy'leri ve API ürünleri oluşturmak, yapılandırmak ve bunları korumak için kullanıcı arayüzünü kullanabilir veya aşağıdaki bölümlerde açıklandığı gibi RESTful hizmetlere erişmek üzere 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ü kullanmayla ilgili bir eğitim için İlk API proxy'nizi oluşturma başlıklı makaleyi inceleyin.
Edge for Private Cloud  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 istek akışlarını proxy'leriniz üzerinden izleyerek API proxy'leri oluşturun.
  • İstemci isteklerine maruz kalmak için proxy'leri paketleyen API ürünleri oluşturun.
  • Geliştiricileri ve geliştirici uygulamalarını yönetme
  • Test ve üretim ortamlarınızı yapılandırın.
  • JavaScript ve Node.js uygulamalarını uygulayın.

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

Edge kullanıcı arayüzündeki API proxy düzenleyicisinde seçili olan 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 düşük düzeyli özelliklere de erişim 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 olarak, API kaynaklarının herhangi birinde HTTP GET, POST, PUT ve DELETE yöntemlerini çağırabilirsiniz.

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

Edge API'sinin 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ğını işaret eden bir uç nokta.

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

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

Kuruluşunuzdaki API proxy'lerinin listesini almak için şunlarda GET çağrısı yaparsınız:

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

Birçok kaynak, ortama göre kapsamlandırılır. Varsayılan olarak iki ortam sağlanır: test ve prod. Örneğin, önbellekler ortama göre kapsamlandırılır. Her ortamda varsayılan olarak "mycache" adlı paylaşılan bir önbellek bulunur.

Önbellek kaynağında GET çağrısı yaparak önbellekleri aşağıdaki gibi listeleyebilirsiniz:

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

Erişimin kimliğini doğrulama

API'leri çağırırken API sunucusunda kimliğinizi doğrulamanız gerekir. Bu işlemi aşağıdaki yöntemlerden biriyle yapabilirsiniz:

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

Edge API sınırları

Her kuruluş için aşağıdaki Edge API çağrı hızları sınırı geçerlidir:

  • Ücretli planlardaki kuruluşlar için dakikada 10.000 çağrı
  • Deneme kuruluşları için dakikada 600 çağrı

401 ve 403 HTTP durum kodları bu sınıra dahil edilmez. Bu sınırları aşan tüm çağrılar 429 Too Many Requests durum kodunu 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.

İstek URL'lerini kısaltma

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

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

Kısaltma 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çbirini kısaltmayın. Aynı yolda hem tam hem de kısaltılmış öğelerin 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ı yürütme

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

API'ye yapılan çağrılarda yanıtlarda gzip sıkıştırma desteklenir. 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ı XML olarak geri gönderebilirsiniz. Bunu yapmak için aşağıdaki örnekte gösterildiği gibi Accept istek başlığını 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 örnekte, yanıtı xmllint üzerinden ileterek sonuçları göstermek için prettyprint kullanıldığını unutmayın.

acurl yardımcı programı, Accept başlığını desteklemiyor. Bu nedenle, acurl ile yalnızca JSON biçimli yanıtlar alabilirsiniz.

JSON yanıtı için prettyprint kullanmak istiyorsanız 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ıta dair bir örnek verilmiştir:

[
  "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 -

XML'de yükleri POST veya PUT ile gönderirken Content-type HTTP üst bilgisini 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ı

Apigee Edge'i kullanan her kuruluşun varsayılan olarak API'leri geliştirmek, test etmek ve dağıtmak için kullanabileceği en az iki ortamı vardır: "test" ve "prod". API'lerinizi herkese açık olarak kullanıma sunmadan önce geliştirmek ve 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 "prod" ortamına dağıtarak uygulama geliştiricilerin herkese açık olarak kullanabilmesini sağlayın.

Hata ayıklama ve test

Apigee, uçtan uca istek ve yanıt akışlarında hata ayıklamanıza olanak tanıyan bir izleme aracı sunar. İzleme sonuçlarında istek ve yanıt başlıkları ile yükleri, politika yürütme, değişken değerleri ve akış sırasında oluşmuş olabilecek hatalar gösterilir.

Sorun gidermede kullanılacak önemli veri noktaları:

  • Zaman damgaları: Her adımın ne kadar sürdüğünü görmek için zaman damgalarını kullanın. Zaman damgalarını karşılaştırmak, yürütülmesi en uzun süren ve API çağrılarınızı yavaşlatan 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ütme sonuçları: Bu sonuçlar, iletinin beklendiği gibi değiştirilip değiştirilmediğini (ör. iletinin XML'den JSON'a dönüştürülüp dönüştürülmediği veya iletinin önbelleğe alınıp alınmadığı) görmenizi sağlar.

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

Edge kullanıcı arayüzündeki API proxy düzenleyicisinde izleme sekmesinin seçili olduğunu gösterir.

Her İzleme oturumu aşağıdaki ana adımlara ayrılır:

  • İstemciden alınan orijinal istek: İstemci uygulamasından gelen isteğin fiilini ve URI yolunu, üstbilgileri, gövde verilerini ve sorgu parametrelerini gösterir.
  • Arka uç hizmetinize gönderilen istek: 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ünü gösterir.
  • İstemciye gönderilen nihai yanıt: Yanıt akışı yürütüldükten sonra, istekte bulunan istemci uygulamasına döndürülen yanıt mesajı.