Question

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

然而，swagger-codegen需要swagger.json作为输入。

我知道，我可以从配备Swagger的运行REST服务器获得此功能。

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

Answer 1

这有点旧，但我想知道完全一样......总之我已经开始研究：

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

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

使用gradle port的swagger-maven-plugin of kongchen。
（不确定这是否重要，因为它无论如何都会启动服务器）通过执行生成规范的集成测试（Spring＆＃39;模拟MVC）。我从here。

我在一个位于here的简单项目中总结了我的研究成果。请参阅Automation部分。代码和示例都包含在内。

Answer 2

主要思想是将swagger-maven-plugin和你的java类添加到buildpath的classpath中，以便能够在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()

Here你可以找到这个例子。

如何使用gradle生成swagger.json？

2 个答案: