Swagger Gradle插件在构建过程中没有正确生成Springmvc的openapi.json文件

Question

我想导入用swagger gradle插件创建的API定义文件。我有一个Spring启动mvc应用程序。我似乎无法获得正确的解析设置来生成openAPI. json。gradle解析任务创建一个空文件，其中只有"openapi"："3.0.1"标记和值。解决的任务不是拿起昂首阔步和mvc api注释。你能给我指出正确的方向，为昂首阔步的gradle解决任务找到正确的配置设置吗？

应用程序显示Spring-UI留档没有问题时，应用程序正在运行，我查看swagger-uiendpoint。问题是在gradle构建期间有一个单独的gradle任务来生成openAPI. json文件，我想将该文件作为应用程序API目录的一部分导入SwaggerHub。

我在任何地方都找不到关于如何配置swagger-gradle插件解析任务以获取Spring MVC API注释的任何文档。我可以让它在另一个使用jax-rs注释的应用程序上正常工作，因此我确信这是一个解决任务配置问题的方法。

一份我的毕业证书。生成文件：

buildscript {
    ext {
        springBootVersion = '1.4.1.RELEASE'
    }
    repositories {
        mavenCentral()
        maven {
          url "https://plugins.gradle.org/m2/"
        }
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
        classpath("io.spring.gradle:dependency-management-plugin:0.5.6.RELEASE")

        // SwaggerHub Plugin Dependency
        classpath("gradle.plugin.io.swagger:swaggerhub:1.0.1")

        // Swagger Gradle Plugin Dependency
        classpath("io.swagger.core.v3:swagger-gradle-plugin:2.0.5") 

    }
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'spring-boot'
apply plugin: 'io.spring.dependency-management'
apply plugin: 'jacoco'
// Required to upload swagger api doc to swaggerhub
apply plugin: 'io.swagger.swaggerhub'
// Required to generate swagger api doc file to upload to swaggerhub
apply plugin: 'io.swagger.core.v3.swagger-gradle-plugin'


jar {
    baseName = 'service-framework'
    version = '0.0.1-SNAPSHOT'
}

javadoc {
    source = sourceSets.main.allJava
}

sourceCompatibility = 1.8
targetCompatibility = 1.8

repositories {
    mavenCentral()
}


dependencies {
    compile('org.springframework.boot:spring-boot-starter-aop')
    compile('org.springframework.boot:spring-boot-starter-jersey')
    compile('org.springframework.boot:spring-boot-starter-web')

    // Swagger Dependencies to generate the api documentation
    compile('io.swagger:swagger-annotations:1.5.20')
    compile('io.springfox:springfox-swagger2:2.8.0')
    compile('io.springfox:springfox-swagger-ui:2.8.0')

    runtime('com.h2database:h2')
    runtime('org.postgresql:postgresql')
    testCompile('org.springframework.boot:spring-boot-starter-test')
    testCompile group: 'org.hamcrest', name: 'hamcrest-core', version: '1.3'
    testCompile group: 'junit', name: 'junit-dep', version: '4.10'
    testCompile group: 'org.hamcrest', name: 'hamcrest-library', version: '1.3'
}

// Command to the swagger gradle plugin to generate the api file for upload
// to swaggerhub
//
//
// Create the directory for output of the api document
File path = new File("${buildDir}/doc")
//
// The Swagger Core Task to create the json output file required to upload
// to SwaggerHub
//
resolve {
    outputFileName = 'openAPI'
    outputFormat = 'JSON'
    prettyPrint = 'TRUE'
    classpath = sourceSets.main.runtimeClasspath
    resourcePackages = ['test.serviceframework']
    outputPath = path.getAbsolutePath();
}

openAPI中的结果输出。json文件：

{
  "openapi" : "3.0.1"
}

Answer 1

我知道这是一个老问题，但自从最初的帖子，Swagger gradle插件没有解决这个问题。然而，Spring Doc有。

https://github.com/springdoc/springdoc-openapi-gradle-plugin

Answer 2

目前似乎还没有一个针对Spring（MVC/Rest）和OpenAPI3的自动文档工具。

SpringFox为Swagger 2做到了这一点。看起来你加了这个，所以你应该在 /v2/api-docs看到你的斯瓦格2医生

io.swagger.core为JAX-RS和泽西做OpenAPI 3

目前的选择是：

• 生成Swagger 2，并将其转换为OpenAPI 3
• 在Spring内部运行JAX-RS