Visual Studio Code için Azure API Center uzantısıyla API'leri bulma ve kullanma

Kuruluşunuzdaki API geliştiricileri, Visual Studio Code için Azure API Center uzantısını kullanarak API merkezinizdeki API'leri bulabilir ve kullanabilir. Uzantı aşağıdaki özellikleri sağlar:

• API'leri bulma - API merkezinizdeki API'lere göz atın ve bunların ayrıntılarını ve belgelerini görüntüleyin.

• API'leri kullanma - Microsoft Graph, GitHub ve daha fazlası için SDK'lar oluşturan Microsoft Kiota altyapısını kullanarak JavaScript, TypeScript, .NET, Python ve Java gibi sık kullanılan dillerinde API SDK istemcileri oluşturun.

API geliştiricileri, API'leri API merkezine kaydetmek 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.

• Visual Studio Code

• Visual Studio Code için Azure API Center uzantısı

• REST istemci uzantısı - HTTP istekleri göndermek ve yanıtları doğrudan Visual Studio Code'da görüntülemek için
• Microsoft Kiota uzantısı - API istemcileri oluşturmak için

Uzantı kurulumu

1. 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.

2. Visual Studio Code'da, soldaki Etkinlik Çubuğu'nda API Center'ı seçin.

   

3. 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'leri bulma

API merkezi kaynakları sol taraftaki ağaç görünümünde görünür. API'leri, sürümleri, tanımları, ortamları ve dağıtımları görmek için bir API merkezi kaynağını genişletin.

Apis ağaç görünümü öğesinde gösterilen arama simgesini kullanarak API Center içinde API'leri arayın.

API belgelerini görüntüleme

API merkezinizde bir API tanımının belgelerini görüntüleyebilir ve API işlemlerini deneyebilirsiniz. Bu özellik yalnızca API merkezinizdeki OpenAPI tabanlı API'ler için kullanılabilir.

1. API tanımını göstermek için API Center ağaç görünümünü genişletin.

2. Tanıma sağ tıklayın ve API Belgelerini Aç'ı seçin. API tanımı için Swagger kullanıcı arabirimiyle yeni bir sekme görüntülenir.

   

3. API'yi denemek için bir uç nokta seçin, Deneyin'i seçin, gerekli parametreleri girin ve Yürüt'e tıklayın.

   Not

   API'ye bağlı olarak, API'yi denemek için yetkilendirme kimlik bilgileri veya API anahtarı sağlamanız gerekebilir.

   İpucu

   Uzantının yayın öncesi sürümünü kullanarak, bakımı ve son kullanıcılarla paylaşılması kolay bir biçim olan Markdown'da API belgeleri oluşturabilirsiniz. Tanıma sağ tıklayın ve Markdown Oluştur'a tıklayın.

HTTP dosyası oluşturma

API merkezinizdeki API tanımına göre bir .http dosyayı görüntüleyebilirsiniz. REST İstemci uzantısı yüklüyse, Visual Studio Code düzenleyicisinden istek dizini oluşturabilirsiniz. Bu özellik yalnızca API merkezinizdeki OpenAPI tabanlı API'ler için kullanılabilir.

1. API tanımını göstermek için API Center ağaç görünümünü genişletin.

2. Tanıma sağ tıklayın ve HTTP Dosyası Oluştur'a tıklayın. API belirtimi tarafından doldurulan bir .http belgesini işleyen yeni bir sekme görüntülenir.

   

3. İstekte bulunmak için bir uç nokta seçin ve İstek Gönder'i seçin.

   Not

   API'ye bağlı olarak, istekte bulunmak için yetkilendirme kimlik bilgileri veya API anahtarı sağlamanız gerekebilir.

API istemcisi oluşturma

Sık kullandığınız dil için bir API istemcisi oluşturmak için Microsoft Kiota uzantısını kullanın. Bu özellik yalnızca API merkezinizdeki OpenAPI tabanlı API'ler için kullanılabilir.

1. API tanımını göstermek için API Center ağaç görünümünü genişletin.
2. Tanıma sağ tıklayın ve API İstemcisi Oluştur'a tıklayın. Kiota OpenAPI Oluşturucu bölmesi görüntülenir.
3. SDK'larınıza eklemek istediğiniz API uç noktalarını ve HTTP işlemlerini seçin.
4. API istemcisi oluştur'a tıklayın.

   1. SDK adı, ad alanı ve çıkış diziniyle ilgili yapılandırma ayrıntılarını girin.

   2. Oluşturulan SDK'nın dilini seçin.

      

İstemci oluşturulur.

Kiota uzantısını kullanma hakkında ayrıntılı bilgi için bkz . Visual Studio Code için Microsoft Kiota uzantısı.

API belirtimlerini dışarı aktarma

Api belirtimlerini bir tanımdan dışarı aktarıp dosya olarak indirebilirsiniz.

Uzantının ağaç görünümünde belirtimi dışarı aktarmak için:

1. API tanımını göstermek için API Center ağaç görünümünü genişletin.

2. Tanıma sağ tıklayın ve API Belirtimi Belgesini Dışarı Aktar'ı seçin. API belirtimi belgesini işleyen yeni bir sekme görüntülenir.

   

Komut Paleti'ni kullanarak bir belirtimi de dışarı aktarabilirsiniz:

1. Komut Paleti'ni açmak için Ctrl+Shift+P klavye kısayolunu yazın.
2. Azure API Center: API Belirtim Belgesini Dışarı Aktar'ı seçin.
3. API tanımına gitmek için seçimler yapın. API belirtimi belgesini işleyen yeni bir sekme görüntülenir.

İlgili içerik

• Azure API Center - temel kavramlar
• Visual Studio Code için Azure API Center uzantısıyla API'ler oluşturma ve kaydetme
• Visual Studio Code için Azure API Center uzantısıyla API'leri yönetme
• Visual Studio Code'da platform API kataloğunu etkinleştirme ve görüntüleme