[英]Generate Java Spring API from OpenAPI 3
我試圖從 OpenAPI v3 YAML 文件生成 Spring REST 接口。 構建 說:
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
但是輸出目錄中沒有生成代碼。
我遵循了OpenAPI 生成器 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"
]
}
我的 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 由生成器正確收集(如果文件中有任何語法錯誤,則構建失敗)。
構建日志說: Successfully generated code to property(...
。不意味着該屬性包含生成的結果,這看起來很可疑嗎?
搖籃版本:
------------------------------------------------------------
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
編輯:
我已經檢查了gradle plugin 中的示例,上面的代碼適用於 Gradle v4,但不適用於 5。我仍在調查中。
問題似乎出在modelFilesConstrainedTo
——它將類限制為Error
。 將其注釋掉,它將起作用(將生成類)。
但是,還有另一個問題: outputDir
。 通過您的設置,它將生成如下內容:
那是錯誤的。 此外,由於它是生成的源,因此不應轉到src/main
。 更好的選擇是在build
目錄中生成它,然后將其添加到編譯類路徑中。 看看我為你創建的演示項目,這里是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)
}
}
請注意,您還需要一堆在生成的源(注釋和 Spring 類)中使用的依賴項。
嘗試在源文件夾內生成如下
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.