Generación de un archivo TypeSpec

Dev Proxy permite generar un archivo TypeSpec a partir de las solicitudes y respuestas de api interceptadas. Con el proxy de desarrollo, puede crear rápidamente un archivo TypeSpec para una API existente y beneficiarse de las herramientas que admiten TypeSpec.

Para generar un archivo TypeSpec mediante el proxy de desarrollo:

1. En el archivo de configuración, habilite el TypeSpecGeneratorPlugin complemento:

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

2. Opcionalmente, configure el complemento en el archivo de configuración:

   {
     "typeSpecGeneratorPlugin": {
       "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/typespecgeneratorplugin.schema.json",
       "ignoreResponseTypes": false
     }
     // [...] shortened for brevity
   }
   

3. En el archivo de configuración, en la lista de direcciones URL que se van a ver, agregue la dirección URL de la API para la que desea generar un archivo TypeSpec:

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

   Sugerencia

   Para crear mejores archivos TypeSpec, considere la posibilidad de usar un modelo de lenguaje local con proxy de desarrollo. Con un modelo de lenguaje local, TypeSpecGeneratorPlugin genera identificadores de operación y descripciones más claros, lo que le proporciona un mejor punto de partida para el archivo TypeSpec. Para obtener más información, consulte Uso de un modelo de lenguaje local.

4. Iniciar proxy de desarrollo:

   devproxy
   

5. Iniciar las solicitudes de grabación presionando r

6. Realice las solicitudes que desea incluir en el archivo TypeSpec.

7. Para detener la grabación de solicitudes, presione s

8. Dev Proxy genera un archivo TypeSpec y lo guarda en un archivo del directorio actual. Dev Proxy asigna al archivo el nombre de host de la API seguido de la fecha y hora actuales, por ejemplo: api.example.com-20231219091700.tsp.

Pasos siguientes

Obtenga más información sobre TypeSpecGeneratorPlugin.

TypeSpecGeneratorPlugin