OpenAPI belirtimi oluşturma

Bir bakışta
Hedef: Kesilen API isteklerinden OpenAPI belirtimi oluşturma
Süre: 10 dakika
Eklentiler:OpenApiSpecGeneratorPlugin
Önkoşullar:Geliştirme Ara Sunucusunu Ayarlama

Dev Proxy, yakalanan API istekleri ve yanıtlarından bir OpenAPI belirtimi oluşturmanıza olanak tanır. Geliştirme Proxy'sini kullanarak mevcut bir API için hızlı bir şekilde OpenAPI belirtimi oluşturabilir ve OpenAPI'yi destekleyen araçlardan yararlanabilirsiniz.

Dev Proxy kullanarak openAPI belirtimi oluşturmak için:

1. Yapılandırma dosyasında eklentiyi OpenApiSpecGeneratorPlugin etkinleştirin:

   Dosya: devproxyrc.json

   {
     "plugins": [
       {
         "name": "OpenApiSpecGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll"
       }
     ]
     // [...] shortened for brevity
   }
   

2. Yapılandırma dosyasında, izleyebileceğiniz URL'ler listesine OpenAPI belirtimi oluşturmak istediğiniz API'nin URL'sini ekleyin:

   Dosya: devproxyrc.json

   { 
     "urlsToWatch": [
       "https://api.example.com/*",
     ]
     // [...] shortened for brevity
   }
   

   İpucu

   Daha iyi OpenAPI belirtimleri oluşturmak için Dev Proxy ile yerel dil modeli kullanmayı göz önünde bulundurun. Daha fazla bilgi için bkz . Yerel dil modeli kullanma.

3. Geliştirme Ara Sunucusunu Başlat:

   devproxy
   

4. Kayıt isteklerine başlamak için r butonuna basın

5. OpenAPI belirtimine eklemek istediğiniz istekleri gerçekleştirme

6. İstekleri kaydetmeyi durdurmak için s tuşuna basın.

7. Dev Proxy bir OpenAPI belirtimi oluşturur ve bunu geçerli dizindeki bir dosyaya kaydeder. Dev Proxy, dosyayı API'nin ana bilgisayar adından sonra geçerli tarih ve saat olarak adlandırır, örneğin: api.example.com-20231219091700.json.

Ayrıca bakınız

• OpenApiSpecGeneratorPlugin - Kapsamlı referans
• Yerel dil modelini kullanma - Oluşturulan özellikleri geliştirme
• OpenAPI belirtimi nedir - Kavramlar
• Sözlük - Geliştirme Ara Sunucusu terminolojisi