瞬间

guqing pushed to feature/api-client in halo-sigs/halo-gradle-plugin

Below is the list of commits:

feat: add tasks for OpenAPI docs and api-client code generation (12952df)

0 0

guqing opened pull request #16 in halo-sigs/halo-gradle-plugin

What this PR does?

实现了两个 tasks，用于为插件项目生成 OpenAPI docs 和 API Client

generateOpenApiDocs: 启动一个 Halo 作为 API Docs Server 并根据用户配置的 groupedApiMappings 来下载 Open API 的 json 文件到指定目录
generateApiClient 根据 groupedApiMappings 指定的文件名称和其他配置来生成 API Client 到前端模块的项目中

使用方式：
在 build.gradle 中配置

haloPlugin {
    openApi {
        outputDir = file("$rootDir/api-docs/openapi/v3_0")
        groupedApiMappings = [
                '/v3/api-docs/apis_aggregated.api_v1alpha1': 'aggregated.json'
        ]
        generator {
            // 默认配置可缺省
            outputDir = file("${projectDir}/console/src/api/generated")
            // 默认配置可缺省
            additionalProperties = [
                    useES6: true,
                    useSingleRequestParameter: true,
                    withSeparateModelsAndApi: true,
                    apiPackage: "api",
                    modelPackage: "models"
            ]
            // 默认配置可缺省
            typeMappings = [
                    set: "Array"
            ]
        }
    }
}