TypeSpecGeneratorPlugin

从截获的请求和响应生成 TypeSpec 文件。

两个命令提示符窗口的屏幕截图。其中一个显示开发代理记录 API 请求。另一个显示生成的 TypeSpec 文件。

插件实例定义

{
  "name": "TypeSpecGeneratorPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
  "configSection": "typeSpecGeneratorPlugin"
}

配置示例

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

配置属性

资产 DESCRIPTION 违约
ignoreResponseTypes 确定是为 API 响应生成类型 ()false 还是将其设置为 stringtrue)。 false

命令行选项

没有

注解

若要创建更好的 TypeSpec 文件,请考虑将本地语言模型与开发代理配合使用。 使用本地语言模型,可以 TypeSpecGeneratorPlugin 生成更清晰的作 ID 和描述,从而为您的 TypeSpec 文件提供更好的起点。 要将本地语言模型与 TypeSpecGeneratorPlugin一起使用,请在配置文件中启用语言模型。 有关详细信息,请参阅 使用本地语言模型