Generowanie pliku TypeSpec

Na pierwszy rzut oka
Celem: Tworzenie obiektu TypeSpec z przechwyconych żądań
Czas: 10 minut
Plugins:TypeSpecGeneratorPlugin
Wymagania wstępne:konfigurowanie serwera proxy deweloperskiego

Dev Proxy umożliwia wygenerowanie pliku TypeSpec z przechwyconych żądań i odpowiedzi API. Za pomocą serwera proxy deweloperskiego można szybko utworzyć plik TypeSpec dla istniejącego interfejsu API i skorzystać z narzędzi obsługujących usługę TypeSpec.

Aby wygenerować plik TypeSpec przy użyciu serwera proxy deweloperskiego:

1. W pliku konfiguracji włącz wtyczkę TypeSpecGeneratorPlugin :

   Plik: 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. Opcjonalnie skonfiguruj sekcję typeSpecGeneratorPlugin . Ustaw ignoreResponseTypes wartość false na (wartość domyślna), aby wtyczka wygenerowała typy odpowiedzi.

3. W pliku konfiguracji do listy adresów URL do obejrzenia dodaj adres URL interfejsu API, dla którego chcesz wygenerować plik TypeSpec.

   Wskazówka

   Aby utworzyć lepsze pliki TypeSpec, rozważ użycie lokalnego modelu językowego z Dev Proxy. Korzystając z lokalnego modelu językowego, typeSpecGeneratorPlugin generuje jaśniejsze identyfikatory operacji i opisy, co daje lepszy punkt wyjścia dla pliku TypeSpec. Aby uzyskać więcej informacji, zobacz Używanie lokalnego modelu językowego.

4. Uruchom serwer proxy deweloperów:

   devproxy
   

5. Rozpocznij nagrywanie żądań, naciskając r

6. Wykonywanie żądań, które mają zostać uwzględnione w pliku TypeSpec

7. Zatrzymywanie żądań nagrywania przez naciśnięcie s

8. Proxy deweloperski generuje plik TypeSpec i zapisuje go w bieżącym katalogu. Dev Proxy nazywa plik używając nazwy hosta API, a następnie bieżącej daty i godziny, na przykład: api.example.com-20231219091700.tsp.

Dalsze kroki

Dowiedz się więcej na temat TypeSpecGeneratorPlugin.

Zobacz także

• Generowanie specyfikacji interfejsu OpenAPI
• Korzystanie z lokalnego modelu językowego
• Rejestrowanie i eksportowanie działania serwera proxy