Azure API Center - temel kavramlar
Bu makalede Azure API Center'ın temel kavramları açıklanmaktadır. Azure API Center, bulma, yeniden kullanma ve idare için api'lerin merkezi bir konumda izlenmesini sağlar.
Veri modeli
Aşağıdaki diyagramda Azure API Center'daki ana varlıklar ve birbirleriyle ilişkileri gösterilmektedir. Bu varlıklar ve ilgili kavramlar hakkında daha fazla bilgi için aşağıdaki bölümlere bakın.
API
Azure API Center'daki en üst düzey mantıksal varlık olan API, izlemek istediğiniz tüm gerçek dünya API'lerini temsil eder. API merkezi REST, GraphQL, gRPC, SOAP, WebSocket ve Web kancası gibi her tür API'yi içerebilir.
Envanterdeki bir API, Azure API Management, Apigee API Management, Kong Konnect, MuleSoft API Management veya başka bir platform gibi herhangi bir API yönetim çözümü tarafından yönetilebilir. Azure API Center'da temsil edilen bir API de yönetilemez.
Azure API Center'daki API envanteri, API program yöneticileri veya BT yöneticileri tarafından oluşturulacak ve yönetilecek şekilde tasarlanmıştır. Azure API Center, API geliştiricilerinin API tanımlarını doğrudan geliştirme ortamlarından kaydetmesine yönelik Visual Studio Code veya CI/CD işlem hatları gibi özellikler de içerir.
API sürümü
API sürümü oluşturma, bir API'de yapılan değişiklikleri yönetme ve bu değişikliklerin istemcileri kesintiye uğratmadan yapılmasını sağlama uygulamasıdır. Bir API'nin yaşam döngüsü aşamalarında her birinin belirli API değişiklikleriyle hizalanmış birden çok sürümü olabilir. Bazı sürümlerde önemli veya hataya neden olan değişiklikler, bazıları ise küçük iyileştirmeler ekleyebilir. API sürümü tasarımdan önizlemeye, üretime veya kullanımdan kaldırmaya kadar her yaşam döngüsü aşamasında olabilir.
API tanımı
Her API sürümü ideal olarak REST API için OpenAPI tanımı gibi en az bir tanım ile tanımlanmalıdır. Azure API Center, metin olarak biçimlendirilmiş tüm API tanım dosyalarına (YAML, JSON, Markdown vb.) izin verir. OpenAPI, gRPC, GraphQL, AsyncAPI, WSDL ve WADL tanımlarını da karşıya yükleyebilirsiniz.
Azure API Center, API idaresine yardımcı olmak için API tanımlarını kuruluş standartlarıyla kalite ve uyumluluk açısından analiz etmeye yönelik lint özellikleri sağlar.
Ortam
Ortam, AZURE API Management hizmeti, Apigee API Management hizmeti veya Kubernetes kümesi, Web Uygulaması veya Azure İşlevi gibi bir işlem hizmeti gibi bir API çalışma zamanının dağıtılabildiği bir konumu temsil eder. Her ortam geliştirme, test, hazırlama veya üretim gibi bir yaşam döngüsü aşamasıyla hizalanır. Ortam, geliştirici portalı veya yönetim arabirimleri hakkında da bilgi içerebilir.
Not
Azure altyapısında barındırılsa da barındırılmasa da API çalışma zamanı ortamlarınızdan herhangi birini izlemek için Azure API Center'ı kullanın. Bu ortamlar Azure Dağıtım Ortamları ile aynı değildir.
Dağıtım
Dağıtım, kullanıcıların bir API'ye erişebileceği bir konumdur (adres). Bir API'nin farklı hazırlama ortamları veya bölgeleri gibi birden çok dağıtımı olabilir. Örneğin, bir API'nin iç hazırlama ortamında bir dağıtımı ve üretim ortamında ikinci bir dağıtımı olabilir. Her dağıtım belirli bir API tanımıyla ilişkilendirilir.
Meta veri
Azure API Center'da api'lerinizi, dağıtımlarınızı ve diğer varlıklarınızı, arama ve filtreleme için kullanılabilecek meta veri değerlerini ayarlayarak ve idare standartlarını zorlamak için düzenleyin. API merkezi, "API türü" ve "yaşam döngüsü aşaması" gibi birçok yaygın yerleşik meta veri özelliği sağlar. API merkezi sahibi API'lerini, dağıtımlarını ve ortamlarını düzenlemek için bir meta veri şemasında özel meta veriler tanımlayarak yerleşik meta verileri genişletebilir. Örneğin, bir API'yi kullanım için onaylamakla sorumlu olan bireyi tanımlamak için bir API onaylayıcı özelliği oluşturun.
Azure API Center dizi, boole, sayı, nesne, önceden tanımlanmış seçimler ve dize türünde özel meta verileri destekler.
Azure API Center'ın meta veri şeması, geliştirici araçlarında ve otomatik işlem hatlarında şema doğrulamasına olanak sağlamak için JSON ve YAML şema belirtimleriyle uyumludur.