KTOR-7748 Generate a server project from OpenAPI specification #34
Conversation
Stexxe
changed the title
|
@antonarhipov, could you also check? |
|
@vnikolova, please check the docs |
|
@Stexxe, thanks for the PR. |
Stexxe
force-pushed
the
stexxe/openapi-generate-project
branch
from
b389707 to
4987a45
Compare
|
I tried this: anton@macbook-pro tmp % ./ktor-cli/ktor openapi -o ktor-project openapi.yml anton@macbook-pro tmp % less /Users/anton/.ktor/run.log: 2024/11/22 18:25:34 16: fetch OpenAPI JAR: unexpected response status 404 from the server: <title>404 - Path /org/openapitools/openapi-generator-cli/7.10.0-SNAPSHOT/openapi-generator-cli-7.10.0-20241106.082455-66.jar not found in local storage of repository "Snapshots" [id=snapshots]</title> ... |
That's strange. I cannot reproduce it at the moment. Can you please try again? |
Co-authored-by: Vik Nikolova <[email protected]>
Co-authored-by: Vik Nikolova <[email protected]>
Co-authored-by: Vik Nikolova <[email protected]>
Co-authored-by: Vik Nikolova <[email protected]>
Co-authored-by: Vik Nikolova <[email protected]>
Co-authored-by: Vik Nikolova <[email protected]>
Co-authored-by: Vik Nikolova <[email protected]>
Co-authored-by: Vik Nikolova <[email protected]>
Stexxe
force-pushed
the
stexxe/openapi-generate-project
branch
from
f87d1fe to
54b5ea0
Compare
| DialContext: func(_ context.Context, network, addr string) (net.Conn, error) { | ||
| return net.DialTimeout(network, addr, 5*time.Second) | ||
| }, | ||
| TLSHandshakeTimeout: 10 * time.Second, |
There was a problem hiding this comment.
Please consider extracting constants
| return e | ||
| } | ||
|
|
||
| return "https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.10.0/openapi-generator-cli-7.10.0.jar" |
There was a problem hiding this comment.
we might also want to have a property for version
There was a problem hiding this comment.
What do you mean by property?
There was a problem hiding this comment.
env variable. URL is hard to use to change just version
https://youtrack.jetbrains.com/issue/KTOR-7748
How to use
Generates a server project using the given OpenAPI specification.
To generate the project, issue the following command in the current working directory:
To generate the project in a different directory, use the
-oor--outputflag:How it works
It downloads a JAR with the OpenAPI CLI Generator utility, saves it into a temp directory, and then executes it as an external command to generate a project. To execute the external command, it tries to find a JDK and downloads one if it cannot be found.
The downloaded JAR is cached in the
~/.ktor/tempdirectory forever until the version of the OpenAPI generator is changed in the source code.Here is a list of issues related to the generated code: