Visual Studio Code için Azure API Center uzantısıyla API'ler oluşturma ve kaydetme
Kuruluşunuzdaki API üreticisi geliştiriciler, Visual Studio Code için Azure API Center uzantısını kullanarak API'leri API merkezi envanterinize oluşturabilir ve kaydedebilir. API geliştiricileri şunları yapabilir:
- Var olan bir API'yi bir API merkezine tek seferlik işlem olarak ekleyin veya API'leri CI/CD iş akışının parçası olarak kaydetmek için bir geliştirme işlem hattını tümleştirin.
- API kodundan yeni OpenAPI belirtimleri oluşturmak için GitHub Copilot'ı kullanın.
API tüketici geliştiricileri, API merkezindeki API'leri bulmak ve kullanmak ve API idaresini sağlamak için uzantıdaki özelliklerden de yararlanabilir.
Önkoşullar
Azure aboneliğinizde bir veya daha fazla API merkezi.
- Şu anda, uzantıyla API'leri yönetmek için bir API merkezinde Azure API Center Hizmeti Katkıda Bulunanı rolüne veya daha yüksek izinlere sahip olmanız gerekir.
Belirtilen senaryolar için aşağıdaki Visual Studio Code uzantıları gereklidir:
- GitHub Actions - GITHub Actions ile CI/CD işlem hattı kullanarak API'leri kaydetmek için
- Azure Pipelines - AZURE Pipelines ile CI/CD işlem hattı kullanarak API'leri kaydetmek için
- GitHub Copilot - API kodundan OpenAPI belirtim dosyaları oluşturmak için
Uzantı kurulumu
Visual Studio Code Market'ten Visual Studio Code için Azure API Center uzantısını yükleyin. Önkoşullar bölümünde listelenen diğer uzantıları yükleyin.
Not
Belirtilen durumlarda, bazı özellikler yalnızca Azure API Center uzantısının yayın öncesi sürümünde kullanılabilir. Visual Studio Code Market'ten uzantıyı yüklerken yayın sürümünü veya yayın öncesi sürümü yüklemeyi seçebilirsiniz. Uzantılar görünümünde uzantının Yönet düğmesi bağlam menüsünü kullanarak istediğiniz zaman iki sürüm arasında geçiş yapın.
Visual Studio Code'da, soldaki Etkinlik Çubuğu'nda API Center'ı seçin.
Azure hesabınızda oturum açmadıysanız Azure'da oturum aç... öğesini seçin ve oturum açmak için istemleri izleyin. API'leri görüntülemek istediğiniz API merkezi (veya API merkezleri) ile bir Azure aboneliği seçin. Ayrıca, görüntülemek istediğiniz çok sayıda abonelik varsa belirli abonelikleri filtreleyebilirsiniz.
API'yi kaydetme - adım adım
Aşağıdaki adımlar API merkezinize bir API'yi tek seferlik bir işlem olarak kaydeder.
- Komut Paleti'ni açmak için Ctrl+Shift+P klavye kısayolunu kullanın. Azure API Center: API'sini kaydedin yazın ve Enter tuşuna basın.
- El ile'yi seçin.
- API'leri kaydetmek için API merkezini seçin.
- API kaydını tamamlamak için API başlığı, türü, sürüm başlığı, sürüm yaşam döngüsü, tanım başlığı, belirtim adı ve tanım dosyası gibi bilgileri içeren istemleri yanıtlayın.
API, API merkezi envanterinize eklenir.
API'leri kaydetme - CI/CD işlem hattı
Aşağıdaki adımlar API merkezinize CI/CD işlem hattıyla bir API kaydeder. Bu seçenekle, her kaynak denetiminde CI/CD iş akışının parçası olarak çalıştırılan etkin Visual Studio Code çalışma alanınıza önceden yapılandırılmış bir GitHub veya Azure DevOps işlem hattı ekleyin. Api zaman içinde gelişmeye devam ettikçe belirtim ve sürüm dahil API meta verilerinin API merkezinizde güncel kalmasını sağlamak için API merkezinizle CI/CD kullanarak API'lerin envanterini çıkarabilirsiniz.
- Komut Paleti'ni açmak için Ctrl+Shift+P klavye kısayolunu kullanın. Azure API Center: API'sini kaydedin yazın ve Enter tuşuna basın.
- CI/CD'yi seçin.
- Tercih ettiğiniz kaynak denetim mekanizmasına bağlı olarak GitHub veya Azure DevOps'yi seçin. Azure API Center uzantısının çalışma alanınıza işlem hattı eklemesi için Visual Studio Code çalışma alanının açık olması gerekir. Dosya eklendikten sonra, gerekli ortam değişkenlerini ve kimliğini yapılandırmak için CI/CD işlem hattı dosyasında belgelenen adımları tamamlayın. Kaynak denetimine gönderildiğinde API, API merkezinize kaydedilir.
API'leri API merkezinize kaydetmek için GitHub Actions iş akışı ayarlama hakkında daha fazla bilgi edinin.
API kodundan OpenAPI belirtimi oluşturma
GITHub Copilot'ın gücünü Visual Studio Code için Azure API Center uzantısıyla kullanarak API kodunuzdan bir OpenAPI belirtimi dosyası oluşturun. API koduna sağ tıklayın, seçeneklerden Copilot'ı seçin ve API belgeleri oluştur'a tıklayın. GitHub Copilot bir OpenAPI belirtimi dosyası oluşturur.
Not
Bu özellik, API Center uzantısının yayın öncesi sürümünde kullanılabilir.
OpenAPI belirtim dosyasını oluşturup doğruluğu denetledikten sonra Azure API Center: REGISTER API komutunu kullanarak API'yi API merkezinize kaydedebilirsiniz.
İpucu
API geliştiricileri, Azure için GitHub Copilot API Center eklentisiyle doğal dil istemlerini kullanarak yeni OpenAPI belirtimleri de oluşturabilir. Daha fazla bilgi edinin.