如何使用 gradle 生成 swagger.json？

java swagger swagger-codegen

2022-09-01 19:32:54

我想使用swagger-codegen来生成REST客户端和可能的静态HTML文档。

但是，swagger-codegen 需要 swagger.json 进行输入。

我知道，我可以从配备Swagger的正在运行的REST服务器获得它。

但是有没有办法直接从我的Java代码中获取swagger.json - 即使用源代码中的gradle生成它 - 而无需在Web容器中运行应用程序，并指向或浏览器指向它？curl

答案 1

这有点旧，但我想知道完全相同...简而言之，我已经开始了研究：

一个示例Spring Boot应用程序，公开了简约的REST API;
对 API 方法的 Swagger 注释;
春狐;
Gradle作为构建工具;

我设法使用两种不同的方法生成JSON规范作为构建工件：

通过使用金刚的swagger-maven-plugin的 gradle端口。
（不确定这是否算数，因为它无论如何都会启动服务器）通过执行生成规范的集成测试（Spring的模拟MVC）。我从这里借用了这个想法。

我在一个简单的项目中总结了我的研究，位于这里。请参阅该部分。包括代码和示例。Automation

答案 2

主要思想是将swagger-maven-plugin和你的java类添加到classpath中，以便buildScript能够在gradle中使用它们，如下所示：

buildscript {
    repositories {
        mavenCentral()
    }

    dependencies {
        classpath files(project(':swagger-maven-example').configurations['runtime'].files)
        classpath files(project(':swagger-maven-example').sourceSets['main'].output.classesDir)
    }
}

其中，依赖项中的第一行从子项目中获取 swagger libs，第二行获取应包含 swagger 注释的类。

在此之后，您可以在gradle中调用maven插件作为一个简单的java类：

// a trick to have all needed classes in the classpath
def customClass = new GroovyClassLoader()

buildscript.configurations.classpath.each {
    // println it.toURI().toURL()
    customClass.addURL(it.toURI().toURL())
}

final ApiDocumentMojo mavenTask = Class.forName('com.github.kongchen.swagger.docgen.mavenplugin.ApiDocumentMojo',true, customClass).newInstance(
        apiSources: [
                new ApiSource(
                        springmvc: false,
                        locations: ['com/github/kongchen/swagger/sample/wordnik/resource'],
                        schemes: ['http', 'https'],
                        host: 'petstore.swagger.wordnik.com',
                        basePath: '/api',
                        info: new Info(
                                title: 'Swagger Maven Plugin Sample',
                                version: 'v1',
                                description: 'This is a sample for swagger-maven-plugin',
                                termsOfService: 'http://www.github.com/kongchen/swagger-maven-plugin',
                                contact: new Contact(
                                        email: 'kongchen@gmail.com',
                                        name: 'Kong Chen',
                                        url: 'http://kongch.com'
                                ),
                                license: new License(
                                        url: 'http://www.apache.org/licenses/LICENSE-2.0.html',
                                        name: 'Apache 2.0'
                                )
                        ),
                        outputPath: file("${buildDir}/swagger/document.html").path,
                        swaggerDirectory: file("${buildDir}/swagger/swagger-ui").path,
                        templatePath: file("${project(':swagger-maven-example').projectDir}/templates/strapdown.html.hbs")
                )
        ]
)

// maven plugin
mavenTask.execute()

在这里，您可以找到此示例。