TypeSpec dosyası oluşturma

Bir bakışta
Hedef: Kesilen isteklerden TypeSpec oluşturma
Süre: 10 dakika
Eklentiler:TypeSpecGeneratorPlugin
Önkoşullar:Geliştirme Ara Sunucusunu Ayarlama

Geliştirme Proxy'si, kesilen API isteklerinden ve yanıtlarından bir TypeSpec dosyası oluşturmanıza olanak tanır. Geliştirme Proxy'sini kullanarak var olan bir API için hızla bir TypeSpec dosyası oluşturabilir ve TypeSpec'i destekleyen araçlardan yararlanabilirsiniz.

Dev Proxy kullanarak bir TypeSpec dosyası oluşturmak için:

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

   Dosya: devproxyrc.json

   {
     "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/rc.schema.json",
     "plugins": [
       {
         "name": "TypeSpecGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
         "configSection": "typeSpecGeneratorPlugin"
       }
     ],
     "urlsToWatch": [
       "https://api.example.com/*"
     ],
     "typeSpecGeneratorPlugin": {
       "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/typespecgeneratorplugin.schema.json",
       "ignoreResponseTypes": false
     }
   }
   

2. İsteğe bağlı olarak typeSpecGeneratorPlugin bölümünü yapılandırın. ignoreResponseTypes Eklentinin yanıt türleri oluşturmasını sağlamak için (varsayılan) olarak ayarlayınfalse.

3. Yapılandırma dosyasında, izleyebileceğiniz URL'ler listesine, typeSpec dosyası oluşturmak istediğiniz API'nin URL'sini ekleyin.

   Tavsiye

   Daha iyi TypeSpec dosyaları oluşturmak için Dev Proxy ile yerel dil modeli kullanmayı göz önünde bulundurun. Yerel dil modeli kullanarak TypeSpecGeneratorPlugin daha net işlem kimlikleri ve açıklamaları oluşturur ve TypeSpec dosyanız için daha iyi bir başlangıç noktası sağlar. Daha fazla bilgi için bkz . Yerel dil modeli kullanma.

4. Geliştirme Ara Sunucusunu Başlat:

   devproxy
   

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

6. TypeSpec dosyasına eklemek istediğiniz istekleri gerçekleştirme

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

8. Dev Proxy bir TypeSpec dosyası oluşturur ve 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.tsp.

Sonraki Adımlar

TypeSpecGeneratorPlugin hakkında daha fazla bilgi edinin.

TypeSpecGeneratorPlugin

Ayrıca bakınız

• OpenAPI belirtimi oluşturma
• Yerel dil modeli kullanma
• Ara sunucu etkinliğini kaydetme ve dışarı aktarma