valitydev/openapi-generator
14
0
Fork 0
mirror of https://github.com/valitydev/openapi-generator.git synced 2024-11-06 10:35:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
334415dec2
openapi-generator/docs/qna.md
William Cheng c9085b4f2b
Update Q&A based on feedback from users (#695) 
* update qna based on feedback from users

* Improvements

* minor fix to typo
2018-08-05 17:49:36 +08:00

3.2 KiB
Raw Blame History

Question and Answer

What is the governance structure of the OpenAPI Generator project?

OpenAPI generator (openapi-generator) is managed by the members of the core team.

What is the difference between Swagger Codegen and OpenAPI Generator?

Swagger Codegen is driven by SmartBear while OpenAPI Generator is driven by the community. More than 40 top contributors and template creators of Swagger Codegen have joined OpenAPI Generator as the founding team members.

Swagger is a trademark owned by SmartBear and the use of the term "Swagger" in this project is for demo (reference) purposes only.

Why was it decided to fork Swagger Codegen and to maintain a community-driven version?

There are several reasons:

  1. The founding members came to the conclusion that Swagger Codegen 3.0.0 beta contains too many breaking changes. They also strongly believe the 3.0.0 release should only focus on one thing: OpenAPI 3.0 support.
  2. The founding members had concerns about the development practices, which seemed to be contributing to an unstable and insufficiently tested codebase.
  3. There was a disagreement on the evolutionary strategy for Swagger Codegen. The founding members felt it was important to move forward with OpenAPI 3.0 support, while maintaining backward compatibility with OpenAPI 2.0 in the same codebase.
  4. The founding members found that the enhancements and bug fixes submitted for Swagger Codegen 2.x need to be submitted again for Swagger Codegen 3.0.0 branch (otherwise, these changes would not appear in the 3.0.0 branch. Having to do the pull request twice is not the best use of community resources).
  5. The community-driven version has a more rapid release cycle (weekly patch release, monthly minor release) so users do not need to wait for several months to get a stable release.
  6. Having a community-driven version can bring the project to the next level with reliable releases and a clear roadmap.

Was anything done to attempt to address the issues before deciding to fork Swagger Codegen and maintain a community-driven version?

There were several conversations with the project owners of Swagger Codegen via emails, Gitter, Skype call and GitHub issues to discuss the state of Swagger Codegen 3.0.0. But there was no consensus on the next steps and on the direction for Swagger Codegen 3.0.0.

Are there any changes to the project license?

No, OpenAPI Generator is still using the Apache license (version 2).

I am currently using Swagger Codegen 2.x. How can I upgrade the generator to OpenAPI Generator?

OpenAPI Generator is based on Swagger Codegen 2.4.0-SNAPSHOT version so the migration should be relatively straightforward. Refer to the migration guide for more information.

Who maintains this Q&A page?

This Q&A page is maintained by the core team members. It is not maintained by a single person nor do these Q&As represent the views of any individual or person.