Sdílet prostřednictvím


TypeSpecGeneratorPlugin

Generuje soubory TypeSpec ze zachycených požadavků a odpovědí.

Snímek obrazovky se dvěma okny příkazového řádku. Jedno ukazuje v Dev Proxy zaznamenávání požadavků na rozhraní API. Druhý ukazuje vygenerovaný soubor TypeSpec.

Definice instance modulu plug-in

{
  "name": "TypeSpecGeneratorPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "typeSpecGeneratorPlugin"
}

Příklad konfigurace

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

Vlastnosti konfigurace

Vlastnictví Popis Výchozí
ignoreResponseTypes Určuje, zda se mají generovat typy pro odpovědi rozhraní API (false) nebo se mají nastavit na string (true). false

Možnosti příkazového řádku

Žádné

Poznámky

Pokud chcete vytvořit lepší soubory TypeSpec, zvažte použití místního jazykového modelu s dev proxy serverem. Pomocí místního jazykového modelu TypeSpecGeneratorPlugin generuje jasnější ID a popisy operací, což vám poskytuje lepší výchozí bod pro soubor TypeSpec. Chcete-li použít místní jazykový model s rozhraním TypeSpecGeneratorPlugin, povolte jazykový model v konfiguračním souboru. Další informace naleznete v tématu Použití místního jazykového modelu.