Generare un file TypeSpec

A colpo d'occhio
Obiettivo: Creare TypeSpec da richieste intercettate
Tempo: 10 minuti
Plugins:TypeSpecGeneratorPlugin
Prerequisiti:Configurare il proxy di sviluppo

Dev Proxy consente di generare un file TypeSpec dalle richieste e dalle risposte api intercettate. Usando Dev Proxy è possibile creare rapidamente un file TypeSpec per un'API esistente e trarre vantaggio dagli strumenti che supportano TypeSpec.

Per generare un file TypeSpec tramite Il proxy di sviluppo:

1. Nel file di configurazione abilitare il plug-in TypeSpecGeneratorPlugin :

   File: 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. Opzionalmente, configurare la sezione typeSpecGeneratorPlugin. Impostare il valore ignoreResponseTypes a false (impostazione predefinita) per far sì che il plug-in generi tipi di risposta.

3. Nel file di configurazione aggiungere all'elenco di URL da controllare l'URL dell'API per cui si vuole generare un file TypeSpec.

   Suggerimento

   Per creare file TypeSpec migliori, è consigliabile usare un modello linguistico locale con Dev Proxy. Usando un modello linguistico locale, TypeSpecGeneratorPlugin genera id operazione e descrizioni più chiari, offrendo un punto di partenza migliore per il file TypeSpec. Per altre informazioni, vedere Usare un modello linguistico locale.

4. Avviare il proxy di sviluppo:

   devproxy
   

5. Avviare la registrazione delle richieste premendo r

6. Eseguire le richieste da includere nel file TypeSpec

7. Arrestare le richieste di registrazione premendo s

8. Dev Proxy genera un file TypeSpec e lo salva in un file nella directory corrente. Dev Proxy assegna un nome al file dopo il nome host dell'API seguito dalla data e dall'ora correnti, ad esempio: api.example.com-20231219091700.tsp.

Passaggi successivi

Altre informazioni su TypeSpecGeneratorPlugin.

TipoSpecGeneratorPlugin

Vedere anche

• Generare specifiche OpenAPI
• Usare un modello linguistico locale
• Registrare ed esportare attività proxy