[英]Generate Java Spring API from OpenAPI 3
I tried to generate Spring REST interfaces from OpenAPI v3 YAML file.我试图从 OpenAPI v3 YAML 文件生成 Spring REST 接口。 Build says:
构建 说:
Successfully generated code to property(class java.lang.String, property(class java.lang.String, fixed(class java.lang.String, /home/zolv/workspaces/main/generation-test/src/main/java)))
Deprecated Gradle features were used in this build, making it
incompatible with Gradle 6.0.
Use '--warning-mode all' to show the individual deprecation warnings.
See https://docs.gradle.org/5.5/userguide/command_line_interface.html#sec:command_line_warnings
But there is no code generated in output directory.但是输出目录中没有生成代码。
I followed OpenAPI generator gradle plugin doc doc.我遵循了OpenAPI 生成器 gradle 插件文档文档。
My build.gradle:我的 build.gradle:
plugins {
id 'java-library'
id "org.openapi.generator" version "4.1.1"
}
repositories {
jcenter()
}
dependencies {
implementation "org.openapitools:openapi-generator-gradle-plugin:3.3.4"
}
openApiGenerate {
generatorName = "spring"
inputSpec = "$rootDir/docs/openapi/api.yml".toString()
outputDir = "$rootDir/src/main/java".toString()
apiPackage = "org.openapi.example.api"
invokerPackage = "org.openapi.example.invoker"
modelPackage = "org.openapi.example.model"
modelFilesConstrainedTo = [
"Error"
]
configOptions = [
dateLibrary: "java8"
]
}
My api.yml:我的 api.yml:
openapi: 3.0.2
info:
title: API Documentation
version: 1.0.0
servers:
- url: http://localhost:8080/
tags:
- name: Users
paths:
/users:
post:
tags:
- Users
summary: Create user
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUserRequest'
responses:
201:
description: New user created
content:
application/json:
schema:
$ref: '#/components/schemas/UserResponse'
components:
schemas:
CreateUserRequest:
title: CreateUserResponse
required:
- username
- password
type: object
properties:
username:
type: string
description: Users's username
example: example@test.com
password:
type: string
description: User's password
example: $tR0nG_pA55vv0Rd
UserResponse:
title: UserResponse
required:
- id
- username
type: object
properties:
id:
type: string
description: Users's identifier
example: "1"
username:
type: string
description: Users's username
example: example@test.com
api.yml is properly gathered by generator (Build fails if there are any syntax errors in the file). api.yml 由生成器正确收集(如果文件中有任何语法错误,则构建失败)。
It looks suspicious that build logs say: Successfully generated code to property(...
. Doesn't mean the property contains the result of generation ?构建日志说:
Successfully generated code to property(...
。不意味着该属性包含生成的结果,这看起来很可疑吗?
Gradle version:摇篮版本:
------------------------------------------------------------
Gradle 5.5
------------------------------------------------------------
Build time: 2019-06-28 17:36:05 UTC
Revision: 83820928f3ada1a3a1dbd9a6c0d47eb3f199378f
Kotlin: 1.3.31
Groovy: 2.5.4
Ant: Apache Ant(TM) version 1.9.14 compiled on March 12 2019
JVM: 11.0.4 (Ubuntu 11.0.4+11-post-Ubuntu-1ubuntu218.04.3)
OS: Linux 4.15.0-1050-oem amd64
Edit:编辑:
I've checked example from gradle plugin , and code above works with Gradle v4, but not with 5. I'm still investigating.我已经检查了gradle plugin 中的示例,上面的代码适用于 Gradle v4,但不适用于 5。我仍在调查中。
The problem seems to be in modelFilesConstrainedTo
— it limits the classes to Error
.问题似乎出在
modelFilesConstrainedTo
——它将类限制为Error
。 Comment it out and it will work (classes will be generated).将其注释掉,它将起作用(将生成类)。
However, there is another problem: outputDir
.但是,还有另一个问题:
outputDir
。 With your setting it will generate something like:通过您的设置,它将生成如下内容:
That's wrong.那是错误的。 Also, as it is a generated source, it should not go to
src/main
.此外,由于它是生成的源,因此不应转到
src/main
。 A better alternative is to generate it in build
directory and then add it to the compilation classpath.更好的选择是在
build
目录中生成它,然后将其添加到编译类路径中。 Take a look at the demo project I've create for you, and here is the build.gradle.kts
(it's almost like Groovy):看看我为你创建的演示项目,这里是
build.gradle.kts
(它几乎就像 Groovy):
plugins {
id("java-library")
id("org.openapi.generator").version("4.0.1")
id("org.springframework.boot").version("2.1.8.RELEASE")
}
repositories {
jcenter()
}
dependencies {
implementation("org.springframework.boot:spring-boot-starter-web:2.1.8.RELEASE")
api("io.springfox:springfox-swagger2:2.8.0")
api("io.springfox:springfox-swagger-ui:2.8.0")
api("org.openapitools:jackson-databind-nullable:0.1.0")
}
val spec = "$rootDir/docs/openapi/api.yml"
val generatedSourcesDir = "$buildDir/generated/openapi"
openApiGenerate {
generatorName.set("spring")
inputSpec.set(spec)
outputDir.set(generatedSourcesDir)
apiPackage.set("org.openapi.example.api")
invokerPackage.set("org.openapi.example.invoker")
modelPackage.set("org.openapi.example.model")
configOptions.set(mapOf(
"dateLibrary" to "java8"
))
}
sourceSets {
getByName("main") {
java {
srcDir("$generatedSourcesDir/src/main/java")
}
}
}
tasks {
val openApiGenerate by getting
val compileJava by getting {
dependsOn(openApiGenerate)
}
}
Note that you'll also need a bunch of dependencies that are used in generated sources (annotations and Spring classes).请注意,您还需要一堆在生成的源(注释和 Spring 类)中使用的依赖项。
Tried to generate inside source folder as below尝试在源文件夹内生成如下
openApiGenerate {
generatorName = "spring"
inputSpec = "$rootDir/src/main/resources/petstore-simple.json".toString()
outputDir = "$rootDir".toString()
apiPackage = "com.example.api"
invokerPackage = "com.example.api"
modelPackage = "com.example.model"
configOptions = [
dateLibrary: "java8"
]
globalProperties = [
modelDocs: "false"
]
}
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.