java - 如何使用 gradle 生成 swagger.json？

Question

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

但是，swagger-codegen 需要 swagger.json 作为输入。

我知道，我可以从配备 Swagger 的正在运行的 REST 服务器获取此信息。

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

Answer 1

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

• 一个暴露简约 REST API 的示例 Spring Boot 应用程序；
• API 方法上的 Swagger 注释；
• 春狐；
• Gradle 作为构建工具；

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

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

我在一个简单的项目中总结了我的研究，位于此处。见Automation章节。包括代码和示例。

Answer 2

主要思想是将 swagger-maven-plugin 和您的 java 类添加到类路径中，以便 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 库，第二行获取应该包含 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()

在这里你可以找到这个例子。