TypeSpec-fájl létrehozása

Egy pillantással
Cél: TypeSpec létrehozása elfogott kérésekből
Idő: 10 perc
Beépülő modulok:TypeSpecGeneratorPlugin
Előfeltételek:Fejlesztői proxy beállítása

A Dev Proxy lehetővé teszi TypeSpec-fájl generálását az elfogt API-kérésekből és válaszokból. A Dev Proxy használatával gyorsan létrehozhat egy TypeSpec-fájlt egy meglévő API-hoz, és kihasználhatja a TypeSpec-t támogató eszközkészletet.

TypeSpec-fájl létrehozása Dev Proxy használatával:

1. A konfigurációs fájlban engedélyezze a beépülő modult TypeSpecGeneratorPlugin :

   Fájl: devproxyrc.json

   {
     "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v3.1.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/v3.1.0/typespecgeneratorplugin.schema.json",
       "ignoreResponseTypes": false
     }
   }
   

2. Igény szerint konfigurálja a szakaszt typeSpecGeneratorPlugin . Állítsa a ignoreResponseTypes értéket false (alapértelmezett) értékre, hogy a beépülő modul választípusokat hozzon létre.

3. A konfigurációs fájlban adja hozzá a megtekinteni kívánt URL-címek listájához annak az API-nak az URL-címét, amelyhez TypeSpec-fájlt szeretne létrehozni.

   Jótanács

   Ha jobb TypeSpec-fájlokat szeretne létrehozni, fontolja meg egy helyi nyelvi modell használatát a Dev Proxyval. Egy helyi nyelvi modell használatával a TypeSpecGeneratorPlugin tisztább műveleti azonosítókat és leírásokat hoz létre, így jobb kiindulópontot biztosít a TypeSpec-fájlhoz. További információ: Helyi nyelvi modell használata.

4. Fejlesztői proxy indítása:

   devproxy
   

5. Nyomja meg a r, hogy elkezdje a kérések felvételét

6. Hajtsa végre a TypeSpec fájlba felvenni kívánt kéréseket

7. A kérések rögzítésének leállításához nyomja meg a s gombot.

8. A Dev Proxy létrehoz egy TypeSpec fájlt, és menti azt az aktuális könyvtár egyik fájljához. A dev proxy az API állomásneve után adja a fájlt, majd az aktuális dátumot és időpontot, például: api.example.com-20231219091700.tsp.

Következő lépések

További információ a TypeSpecGeneratorPlugin típusról.

Lásd még

• OpenAPI-specifikáció létrehozása
• Helyi nyelvi modell használata
• Proxytevékenység rögzítése és exportálása