Where to find information of OpenAPI tools and steps to setup and run OpenAPI generator

All about the OpenAPI tools

The OpenAPI tools are derived from swagger tools. They feels almost identical to new comer. The tool enables automatic generation of API documents and server-client interface libraries.

Unlike the swagger tools, OpenAPI tools are more open there¡¯re all kinds of groups developed different kinds of tools base on the OpenAPI SPEC. While there¡¯re too many choices, it also brings difficulties to new user to getting start with the OpenAPI.

Documents to read

This is a list of links I¡¯d go through. The github project¡¯s readme includes a very long list of OpenAPI practice arities.

• https://www.baeldung.com/spring-rest-openapi-documentation
• https://www.baeldung.com/java-openapi-generator-server
• https://www.baeldung.com/java-dto-pattern
• https://openapi.tools/
• https://openapi-generator.tech
• https://medium.com/swlh/openapi-swagger-ui-codegen-with-spring-boot-1afb1c0a570e
• https://github.com/OpenAPITools/openapi-generator

An pathway to getting started

If I'd go this way, it would save my many days to reach the current level of knowledge of OpenAPI and its tools.

1. Goal of using the OpenAPI tools. My goal is to reduce manually API fronend/backend composing work by make use of OpenAPI generator. As a business developer, I would like to concentrate on my logic instead of fronend/backend interaction.
2. Follow the installation guide, install a CLI version to get familiar with OpenAPI generator FIRST.
3. Follow the bealdung java openapi generator server tutorial, set up a spring/java project to practice.
4. Learn Data Transfer Pattern, to get to know how to work with generated code.
5. Read the spring/jersey/axios server/client generator documents to get to know how to customize specific language generator.
6. Read openapi-generator-maven-plugin introduction, to know to customize code generation in project.