API geliştirme yaşam döngüsü

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

Her kuruluşun benzersiz bir yazılım geliştirme yaşam döngüsü (SDLC) vardır. Çoğunlukla API proxy dağıtımını şu anda kullandığınız işlemlerle senkronize etmek ve uyumlu hale getirmek için diğer uygulamaları geliştirmek, test etmek ve dağıtmak.

API Hizmetleri, API proxy dağıtımını entegre etmenizi sağlayan araçlar ve RESTful API'ler sunar ve yönetimini kuruluşunuzun SDLC'sine entegre edebilirsiniz. RESTful API'nin yaygın bir kullanımı, API proxy'lerini programlı bir şekilde dağıtan ya da API proxy'lerini dağıtan veya taşıyan daha büyük bir otomatik işlemin parçası olarak izin verir. API Hizmetleri, SDLC'niz (veya başkasınınkiler) hakkında herhangi bir varsayımda bulunmaz konu). Aksine, geliştirme ekibiniz tarafından koordine edilebilecek atomik fonksiyonları API geliştirme yaşam döngünüzü otomatikleştirip optimize edin.

API Hizmetleri API'leri, API Referansı'nda açıklanmıştır. Görüntüleyin API referansı alınıyor başladı.

Ortam

Apigee Edge'deki her kuruluş, kullanılabilir en az iki dağıtım ortamına sahiptir API proxy'leri için: "test" ve "prod". İki ortam arasındaki fark rastgeledir Her ortam farklı bir ağ adresi (URL) grubuyla tanımlanır. İlgili içeriği oluşturmak için kullanılan hedef, size API'den önce API proxy'leri oluşturup doğrulayabileceğiniz bir alan sağlamaktır harici geliştiricilere açıktır.

SDLC Her ortam bir ağ adresiyle tanımlanır; bu sayede, ortamlar arası trafiği ayırabilirsiniz ve uygulamaların çalışma zamanında eriştiği API proxy'leri. Her ortam için kullanılabilen ağ adresleri, VirtualHosts kümesinde tanımlanır. erişilebilir hale getirebilirsiniz.

Gelen, sunucu TLS/SSL'si her ortam için otomatik olarak etkinleştirilir. İki VirtualHost her ortamda önceden tanımlanmış: default ve secure. Varsayılan değer, HTTP adresi, güvenli ise önceden yapılandırılmış sunucu tarafı TLS/SSL ile bir HTTP/S adresini tanımlar. İçinde ProxyEndpoint'in hangi VirtualHost'ları dinlemesi gerektiğini belirtirsiniz. Üretime tanıtım yaparken genellikle default öğesini kaldırarak HTTP'yi devre dışı bırakırsınız. API proxy yapılandırmasından VirtualHost.

Örneğin, aşağıdaki ProxyEndpoint, HTTP ve HTTPS'de dinleme yapar.

<HTTPProxyConnection>
  <BasePath>/v0/weather</BasePath>
  <Properties/>
  <VirtualHost>default</VirtualHost>
  <VirtualHost>secure</VirtualHost>
</HTTPProxyConnection>

default VirtualHost alanını ProxyEndpoint yapılandırmasından silerek yalnızca HTTPS'de dinleyen, HTTP'de olmayan bir API proxy'si oluşturun.

<HTTPProxyConnection>
  <BasePath>/v0/weather</BasePath>
  <Properties/>
  <VirtualHost>secure</VirtualHost>
</HTTPProxyConnection>

Bir ortamda hangi VirtualHost'ların mevcut olduğunu Yönetim arayüzü ana menüsünde Ortamlar.

Ortamlar ayrıca veri ve kaynakların ayrılmasını sağlar. Örneğin, aylık bazda test ve üretimde farklı önbelleklere izin verir. Bunlar, yalnızca ilgili önbellekte çalışan API proxy'leri tarafından bahsedeceğim. Ayrıca, test ortamında yayınlanan API anahtarları ve tam tersi de geçerlidir.

Ortamlara API proxy'leri dağıtma

API proxy'si oluşturduğunuzda hangi ortamda çalışacağınıza karar vermeniz gerekir. Siz üretimde yeni bir API proxy'si oluşturmayı seçebilir, ancak hazırlamaya çalışırsınız. Genel olarak başlangıçta bir API proxy'si oluşturun: test ve daha sonra, testten sonra tanıtım prod.

Daha fazla bilgi için bkz. Dağıtımı anlama.

Testte yinelemeli geliştirme

Bir API proxy'si üzerinde çalışırken API Hizmetleri, yapılandırmanızın yinelemelerini düzeltmeler hakkında daha fazla bilgi edinin. API proxy'si dağıttığınızda dağıtmak için belirli bir düzeltme seçersiniz. Genellikle en son düzeltmeyi dağıtırsınız ve gerekirse önceki düzeltmeye geri dönersiniz. düzeltme numarası. Bu düzeltmelerin nereye dağıtılacağını seçebilirsiniz. Örneğin, Yeşil Ofis projenizde geliştiricilerin API'nizle çalışmaya başlayabilmesi için üretime yönelik revizyon Aynı zamanda siz de özellikler veya ince ayar politikaları eklediğiniz birden fazla revizyonu test etmek. Ardından, Hazır olduğunuzda yeni düzeltmeyi üretime dağıtabilir, teslim etmeye yardımcı olur. Bu yöntemi kullanarak her zaman için API'nizin canlı bir düzeltmesini size yardımcı olmaya hazırım.

Üretime yükseltme

Bir API proxy'si tamamen uygulanıp test edildiğinde "üretim" düzeyine yükseltilmeye hazır hale gelir. Test edilen API proxy'sinin revizyonu, API proxy'sinin revizyonunun üzerine yazmak için kullanılır üretimde dağıtılmaktadır.

API Hizmetleri, API proxy'lerinin sorunsuz bir şekilde dağıtılmasını sağlamada performansı uygulamalar ve son kullanıcılar üzerindeki etkisi hakkında daha fazla bilgi edineceksiniz.

Komut dosyası çalıştırma dağıtımı

Apigee Edge yönetim kullanıcı arayüzü, doğrudan API'den üretim yapmak için API proxy'leri dağıtmanıza olanak tanır proxy oluşturucuyu kullanabilirsiniz. Ancak birçok durumda; güvenlik, güvenilirlik ve geliştirme ekiplerinin dağıtım prosedürlerini komuta etmesini zorunlu kılar. Bunun için: API hizmetleri tarafından kullanıma sunulan RESTful API'yi çağıran kod ve komut dosyaları yazma

Ortam kaynakları

Promosyon sırasında ek kontrol için yalnızca API'de yineleme yapmanız önerilir. proxy'leri test edin ve üretimde dağıtılan API proxy'lerinde gerekli değişiklikleri yapın.

Bunu yapmak için her ortamla ilişkili belirli kaynakların bir API proxy yapılandırmasında statik kalabilecek şekilde yapılandırılmıştır.

• Hedef URL'ler: API proxy'lerinin test sırasında farklı arka uç URL'lerini çağırması yaygın bir durumdur. çok önemlidir. Ortamdan bağımsız uygulamalar oluşturmak için TargetServer yapılandırmalarını kullanabilirsiniz. TargetEndpoint yapılandırmaları. Görüntüleyin Arka uç sunucuları arasında yük dengeleme.
• Önbellekler ve anahtar/değer eşlemeleri: Her iki kalıcılık kaynağı ortama göre belirlenir. Şunları yapmalısınız: API proxy'lerinin kullanmadan veri depolamasını sağlamak için adlandırma kurallarının kullanıldığından emin olun veya yapılandırma değişiklikleri olabilir. Görüntüleyin Ortam önbelleği oluşturma ve düzenleme.
• Hizmet açıklama metinleri: Hizmet çağrıları, Örneğin, test ortamındaki bir Hizmet Çağrısı bir demo hizmeti kullanıyorsa. Hizmet Açıklama Metni Politikası'nı inceleyin.

API proxy yapılandırmalarını ortamdan bağımsız hale getirmek için açıklamalarına dikkat edin. environment.name değişkeniyle derlenen koşullu ifade şöyle olabilir: Bir politikayı zorunlu kılmadan veya şurada bir URL'ye yönlendirme yapılmadan önce mevcut ortamı değerlendirmek için kullanılır: arka uçta yer alır.

Daha fazla bilgi için Dağıtımı anlama sayfasına bakın.