Azure API Center - temel kavramlar

Bulma, yeniden kullanma ve idare için API'leri merkezi bir konumda izlemenize olanak tanıyan Azure API Center'ın temel kavramlarını keşfedin.

Veri modeli

Azure API Center yapılandırmasındaki ana varlıklar API'lerinizi ve bunların sürümlerini, tanımlarını ve dağıtımlarını içerir. Her bir API için olası çalışma zamanı ortamları ve açıklayıcı meta veriler yapılandırmayı tamamlar.

Aşağıdaki diyagramda ana varlıklar ve birbirleriyle ilişkileri gösterilmektedir.

Azure API Center'da veri modelinin temel özelliklerini gösteren diyagram.

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. Api center envanterinize yerel ve uzak MCP sunucularını ve A2A aracılarını da ekleyebilirsiniz.

Envanterdeki bir API'yi herhangi bir API yönetim çözümüyle yönetebilirsiniz. Örneğin Azure API Management, Apigee API Management, Kong Konnect, MuleSoft API Management veya başka bir platform kullanın. Azure API Center'da temsil edilen bir API de yönetilemez.

API program yöneticileri veya BT yöneticileri Azure API Center'da API envanteri oluşturabilir ve yönetebilir. 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 istemcileri kesintiye uğratmadan değişikliklerin 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 büyük 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ı

Rest API için OpenAPI tanımı gibi her API sürümü için en az bir tanım olmalı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 veya Apigee API Management hizmeti gibi bir API çalışma zamanının dağıtılabilir olduğu konumu temsil eder. Kubernetes kümesi, Web Uygulaması veya Azure İşlevleri uygulaması gibi bir işlem hizmetine de dağıtabilirsiniz. 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ılıp barındırılmadıklarına bakılmaksızın 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 meta veri değerlerini ayarlayarak API'lerinizi, dağıtımlarınızı ve diğer varlıklarınızı düzenleyin. Meta veriler, idare standartlarını aramak, filtrelemek ve zorlamak için kullanışlıdır. API merkezi, API type ve lifecycle stage gibi çeşitli yaygın yerleşik meta veri özellikleri 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 meta veri özelliği oluşturun API approver .

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.