如何将 openapi.yaml 添加到您的项目中

Question

How to add openapi.yaml to an existing project with already written code for REST API? In what folder should I put the yaml file and what "configuration" needs to be done for it to work properly (display swagger UI)?

Note: using dropwizard framework

Answer 1

I was running into several issues myself using Open API with Spring/Dropwizard. So I started building an alternative that makes repo integration easier ( https://github.com/fern-api/fern ).

Steps to get started:

1. You can install it with npm install -g fern-api
2. Run fern init which will create an api directory that has an API definition
3. Run fern add java to add the java generator
4. Run fern generate to generate the java subproject
5. Add a dependency on the java subproject and implement your APIs

https://docs.buildwithfern.com/#/ There's a video here on how to get started with Java.

If you want to add an openapi.yml after, you will be able to convert the fern api definition into a valid Open API.

Apologies if this wasn't the answer you were looking for, just figured I'd share an alternative that might solve your problem!