API merkezinizdeki API'leri analiz etme - Microsoft tarafından yönetilen

Kuruluşunuzun API merkezi , hem bireysel hem de özet raporlar oluşturarak api tanımlarını kuruluş stili kurallarına uygun olarak analiz etmek için yerleşik, Microsoft tarafından yönetilen lint özellikleri (önizleme) içerir. API analizi, API tanımlarınızdaki yaygın hataları ve tutarsızlıkları tanımlamanıza ve düzeltmenize yardımcı olur.

API analizi ile:

• Azure API Center, BIR API tanımı eklediğinizde veya güncelleştirdiğinizde API tanımlarınızı otomatik olarak analiz eder. API tanımları varsayılan olarak spektral:oas kural kümesiyle (API stil kılavuzu) linted.
• API çözümleme raporları Azure portalında oluşturulur ve API tanımlarınızın stil kılavuzuna nasıl uygun olduğunu gösterir.
• Visual Studio Code için Azure API Center uzantısını kullanarak kendi API stili kılavuzunuzu yerel olarak özelleştirebilir ve test edebilir ve ardından api merkezinize dağıtabilirsiniz.

Sınırlamalar

• Şu anda yalnızca JSON veya YAML biçimindeki OpenAPI ve AsyncAPI belirtim belgeleri analiz edilir.
• Şu anda tek bir kural kümesi yapılandırabilirsiniz ve bu kural kümesi API merkezinizdeki tüm OpenAPI tanımlarına uygulanır.
• Analiz edilen en fazla API tanımı sayısı için sınırlar vardır. Analizin tamamlanması birkaç dakika ile 24 saat kadar sürebilir.

Önkoşullar

• Azure aboneliğinizde bir API merkezi. Henüz oluşturmadıysanız bkz . Hızlı Başlangıç: API merkezinizi oluşturma.
• Kural kümesini, Visual Studio Code'ı ve aşağıdaki Visual Studio Code uzantılarını özelleştirmek için:
  • Visual Studio Code için Azure API Center uzantısı
  • Visual Studio Code için spektral uzantı

API çözümleme raporlarını görüntüleme

Azure portalında API tanımlarınız için analiz özetini ve analiz raporlarını görüntüleyin. API tanımları analiz ettikten sonra raporlar, yapılandırılan API stili kılavuzuna göre hataları, uyarıları ve bilgileri listeler.

API çözümleme raporunda, analiz için kullanılan kural kümesini ve lint geçişlerinin geçmişini de gözden geçirin.

API merkezinizde analiz özetini görüntülemek için:

1. Portalda API merkezinize gidin.

2. Sol taraftaki menüde, İdare'nin altında API Analizi'ni seçin. Özet görüntülenir.

   

3. İsteğe bağlı olarak BIR API tanımı için API Çözümleme Raporu simgesini seçin. Tanımın API çözümleme raporu, aşağıdaki ekran görüntüsünde gösterildiği gibi görüntülenir.

   

   İpucu

   API tanımının menü çubuğundan Çözümleme'yi seçerek DE API çözümleme raporunu görüntüleyebilirsiniz.

Kural kümesini özelleştirme

Visual Studio Code için Azure API Center uzantısını kullanarak API merkezinizin varsayılan kural kümesini özelleştirebilir veya kuruluşunuzun API stili kılavuzu olarak değiştirebilirsiniz. Örneğin, kural kümesini genişletebilir veya özel işlevler ekleyebilirsiniz.

Kural kümesini özelleştirmek veya değiştirmek için:

1. Visual Studio Code'da Etkinlik Çubuğu'ndan Azure API Center simgesini seçin.
2. .api-center-rules Çalışma klasörünüzün kökündeki klasörü açın.
3. API center kaynağınızın klasöründe dosyayı ruleset.yml açın.
4. İçeriği gerektiği gibi değiştirin veya değiştirin.
5. Değişikliklerinizi olarak ruleset.ymlkaydedin.

Kural kümesini yerel olarak test edin

Özel kural kümesini API merkezinize dağıtmadan önce yerel olarak doğrulayın. Visual Studio Code için Azure API Center uzantısı, Spectral ile birlikte API belirtimi için tümleşik destek sağlar.

1. Visual Studio Code'da, Komut Paleti'ni açmak için Ctrl+Shift+P klavye kısayolunu kullanın.

2. Azure API Center: Etkin API Stil Kılavuzu'nu ayarlayın ve Enter tuşuna basın.

3. Yerel Dosya Seç'i seçin ve özelleştirdiğiniz dosyayı belirtinruleset.yml. Enter tuşuna basın.

   Bu adım, özel kural kümesini lint için etkin API stili kılavuzu yapar.

Artık OpenAPI tabanlı bir API tanım dosyasını açtığınızda, Visual Studio Code'da yerel bir linting işlemi otomatik olarak tetikleniyor. Sonuçlar düzenleyicide ve Sorunlar penceresinde (Sorunları Görüntüle > veya Ctrl+Shift+M) satır içinde görüntülenir.

Lint sonuçlarını gözden geçirin. Kural kümesinde gerekli ayarlamaları yapın ve istediğiniz şekilde performans gösterene kadar yerel olarak test etmeye devam edin.

Kural kümesini API merkezinize dağıtma

Özel kural kümesini API merkezinize dağıtmak için:

1. Visual Studio Code'da Etkinlik Çubuğu'ndan Azure API Center simgesini seçin.
2. API Center bölmesinde, kural kümesini özelleştirdiğiniz API center kaynağını genişletin.
3. Kurallar'a sağ tıklayın ve Kuralları API Center'a Dağıt'ı seçin.

Kurallar API merkezinize başarıyla dağıtıldıktan sonra size bir ileti bildirir. Linting altyapısı, API tanımlarını analiz etmek için güncelleştirilmiş kural kümesini kullanır.

Güncelleştirilmiş kural kümesiyle lint sonuçlarını görmek için portalda API çözümleme raporlarını görüntüleyin.

İlgili içerik

• Varsayılan yerleşik kural kümesi hakkında daha fazla bilgi edinmek için Spectral GitHub deposuna bakın.
• API merkezinizde API analizini etkinleştirme - kendi kendine yönetilen