azuresdk/swagger-to-sdk

azuresdk/swagger-to-sdk 镜像说明

镜像概述

本镜像是微软Azure SDK团队提供的自动化工具，旨在从Swagger规范文件生成对应的SDK代码。它支持在每次Swagger文件提交时自动执行SDK语言测试，并向各语言SDK仓库提交PR，仅兼容Python 3.6环境。

核心功能

• 对SDK语言进行自动化测试验证
• 针对各语言SDK仓库自动提交Pull Request
• 通过配置文件自定义生成流程（如后处理脚本、Autorest参数等）

使用场景

• 微软Azure相关服务SDK的自动化生成与更新
• 团队内部基于Swagger规范的SDK开发流程自动化
• 批量生成或更新多个SDK项目的场景

配置说明

需在仓库根目录放置swagger_to_sdk.json配置文件，示例如下：

json
{
  "$schema": "https://raw.githubusercontent.com/Azure/swagger-to-sdk/master/swagger_to_sdk_config.schema.json",
  "meta": {
    "after_scripts": [
      "gofmt -w ./services/"
    ],
    "version":"0.2.0",
    "autorest_options": {
      "license-header": "MICROSOFT_MIT_NO_VERSION",
      "payload-flattening-threshold": 2,
      "python": "",
      "azure-arm": true,
      "sdkrel:python-sdks-folder": "."
    },
    "envs": {
      "sdkrel:SCRIPTPATH": "./scripts"
    },
    "advanced_options": {
      "clone_dir": "./src/github.com/Azure/azure-sdk-for-go"
    },
    "wrapper_filesOrDirs": [],
    "delete_filesOrDirs": [
      "credentials.py",
      "exceptions.py"
    ],
    "generated_relative_base_directory": "*client"
  },
  "projects": {
    "authorization": {
      "autorest_options": {
        "input-file": "arm-authorization/2015-07-01/swagger/authorization.json",
        "namespace": "azure.mgmt.authorization",
        "package-version": "0.30.0"
      },
      "output_dir": "azure-mgmt-authorization/azure/mgmt/authorization",
      "build_dir": "azure-mgmt-authorization"
    },
    "recoveryservicesbackup": {
      "markdown": "arm-recoveryservicesbackup/readme.md",
      "generated_relative_base_directory": "Generated/Python/azure/mgmt/recoveryservicesbackup",
      "output_dir":  "azure-mgmt-recoveryservicesbackup/azure/mgmt/recoveryservicesbackup",
      "build_dir": "azure-mgmt-recoveryservicesbackup"
    }
  }
}

Meta配置项

version

配置文件版本必须为0.2.0。

after_scripts

生成完成后执行的命令列表，按顺序执行，当前工作目录为克隆路径。

autorest_options

传递给Autorest的参数字典，可被项目级配置覆盖。前缀为sdkrel:的选项会解析为SDK文件夹的相对路径。

envs

after_scripts的环境变量，前缀为sdkrel:的选项会解析为SDK文件夹的相对路径。

advanced_options > clone_dir

克隆仓库时的额外文件夹层级（主要用于Go语言）。

wrapper_filesOrDirs

生成SDK时保留的文件/目录列表，支持Bash通配符。

delete_filesOrDirs

生成SDK时删除的文件/目录列表，支持Bash通配符。

generated_relative_base_directory

Autorest生成数据的相对根目录，在delete_filesOrDirs前生效。

Projects配置项

键为项目ID（推荐命名空间风格），值包含以下字段：

• markdown：Autorest MD文件路径（可选）
• autorest_options：项目级Autorest参数（覆盖Meta配置）
• wrapper_filesOrDirs：项目级保留文件列表（与Meta合并）
• delete_filesOrDirs：项目级删除文件列表（与Meta合并）
• generated_relative_base_directory：项目级生成数据根目录（替换Meta配置）
• output_dir：SDK生成文件的目标文件夹
• build_dir：生成元数据存放目录（可选，需唯一）

Docker部署示例

基本运行

bash
docker run -v $(pwd):/workspace azuresdk/swagger-to-sdk

挂载配置与Swagger目录

bash
docker run -v /path/to/swagger-files:/swagger -v /path/to/config:/config azuresdk/swagger-to-sdk --rest-folder /swagger --config /config/swagger_to_sdk.json