Visual Studio Code için Azure API Center uzantısıyla API'leri yönetme
API idaresi çalışmalarınızın başarısını en üst düzeye çıkarmak için, api geliştirme döngüsünün erken aşamalarında sola kaydırmak kritik önem taşır. Bu yaklaşım, API geliştiricilerinin API'leri en baştan doğru şekilde oluşturmasına olanak tanır ve bu api'leri geliştirme sürecinin ilerleyen bölümlerinde boşa harcanan geliştirme çabalarından ve uyumsuz API'lerden tasarruf eder.
Visual Studio Code için Azure API Center uzantısı, API geliştiricileri için aşağıdaki idare özelliklerini içerir:
- API tasarımlarını, API Visual Studio Code'da geliştirilirken API stili kılavuzlarında değerlendirme.
- Hataya neden olan değişikliklerin erken tespiti, API'lerin güvenilir kalmasını ve beklendiği gibi çalışmasını sağlayarak son kullanıcıların ve paydaşların güvenini korur.
API geliştiricileri, API'leri API merkezine kaydetmek ve API'leri bulup kullanmak 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.
- Visual Studio Code için spektral uzantı - Visual Studio Code'da shift-left API tasarım uyumluluk denetimleri çalıştırmak için
- Optik CLI - API belirtimi belgeleri arasındaki hataya neden olan değişiklikleri algılamak 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 tasarımı uyumluluğu
SIZ API'leri oluştururken tasarımın kuruluş standartlarına uygun olmasını sağlamak için Visual Studio Code için Azure API Center uzantısı, Spectral ile birlikte API belirtimi için tümleşik destek sağlar.
- Komut Paleti'ni açmak için Ctrl+Shift+P klavye kısayolunu kullanın. Azure API Center: Etkin API Stil Kılavuzu'nu ayarlayın ve Enter tuşuna basın.
- Sağlanan varsayılan kurallardan birini seçin veya kuruluşunuzda zaten kullanılabilir bir stil kılavuzu varsa, Visual Studio Code'da etkin kural kümesini belirtmek için Yerel Dosya Seç veya Uzak Giriş URL'sini kullanın. Enter tuşuna basın.
Etkin bir API stili kılavuzu ayarlandıktan sonra, openAPI veya AsyncAPI tabanlı belirtim dosyalarının açılması Visual Studio Code'da yerel bir linting işlemini tetikler. Sonuçlar hem düzenleyicide hem de Sorunlar penceresinde (Sorunları Görüntüle>veya Ctrl+Shift+M) satır içinde görüntülenir.
Hataya neden olan değişiklik algılama
API'nizin yeni sürümlerini kullanıma sunarken, yapılan değişikliklerin API'nizin önceki sürümlerinde API tüketicilerini bozmadığından emin olmak önemlidir. Visual Studio Code için Azure API Center uzantısı, Optik tarafından desteklenen OpenAPI belirtimi belgeleri için hataya neden olan değişiklik algılama özelliğiyle bunu kolaylaştırır.
- Komut Paleti'ni açmak için Ctrl+Shift+P klavye kısayolunu kullanın. Azure API Center: HataYazı Değişikliği Algıla yazın ve Enter tuşuna basın.
- Karşılaştıracak ilk API belirtimi belgesini seçin. Geçerli seçenekler arasında API merkezinizde bulunan API belirtimleri, yerel bir dosya veya Visual Studio Code'daki etkin düzenleyici yer alır.
- Karşılaştıracak ikinci API belirtimi belgesini seçin. Geçerli seçenekler arasında API merkezinizde bulunan API belirtimleri, yerel bir dosya veya Visual Studio Code'daki etkin düzenleyici yer alır.
Visual Studio Code, iki API belirtimi arasında fark görünümü açar. Tüm hataya neden olan değişiklikler hem düzenleyicide hem de Sorunlar penceresinde (Sorunları Görüntüle>veya Ctrl+Shift+M) görüntülenir.
