openapi-generator | OpenAPI Generator allows generation of API client libraries | Generator Utils library

 by   OpenAPITools Java Version: v6.6.0 License: Apache-2.0

kandi X-RAY | openapi-generator Summary

kandi X-RAY | openapi-generator Summary

openapi-generator is a Java library typically used in Generator, Generator Utils, Swagger applications. openapi-generator has build file available, it has a Permissive License and it has high support. However openapi-generator has 1662 bugs and it has 19 vulnerabilities. You can install using 'pip install openapi-generator' or download it from GitHub, GitLab, PyPI.

OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (both 2.0 and 3.0 are supported). Currently, the following languages/frameworks are supported:.

            kandi-support Support

              openapi-generator has a highly active ecosystem.
              It has 16742 star(s) with 5363 fork(s). There are 211 watchers for this library.
              There were 2 major release(s) in the last 12 months.
              There are 3681 open issues and 3097 have been closed. On average issues are closed in 231 days. There are 438 open pull requests and 0 closed requests.
              It has a positive sentiment in the developer community.
              The latest version of openapi-generator is v6.6.0

            kandi-Quality Quality

              openapi-generator has 1662 bugs (385 blocker, 0 critical, 718 major, 559 minor) and 60081 code smells.

            kandi-Security Security

              openapi-generator has 1 vulnerability issues reported (0 critical, 1 high, 0 medium, 0 low).
              openapi-generator code analysis shows 18 unresolved vulnerabilities (0 blocker, 14 critical, 4 major, 0 minor).
              There are 143 security hotspots that need review.

            kandi-License License

              openapi-generator is licensed under the Apache-2.0 License. This license is Permissive.
              Permissive licenses have the least restrictions, and you can use them in most projects.

            kandi-Reuse Reuse

              openapi-generator releases are available to install and integrate.
              Deployable package is available in PyPI.
              Build file is available. You can build the component from source.
              Installation instructions are not available. Examples and code snippets are available.
              openapi-generator saves you 2136146 person hours of effort in developing the same functionality from scratch.
              It has 870656 lines of code, 87826 functions and 12714 files.
              It has medium code complexity. Code complexity directly impacts maintainability of the code.

            Top functions reviewed by kandi - BETA

            kandi has reviewed openapi-generator and discovered the below as its top functions. This is intended to give you an instant insight into openapi-generator implemented functionality, and help decide if they suit your requirements.
            • Flattens all the features in this set .
            • Invoke an API
            • Create a Request object .
            • Copy this parameter .
            • Parse a part .
            • Get example value .
            • Creates a new rule .
            • Test endpoint parameters for OkHttp3 .
            • Generate a string from the given options .
            • Preprocess OpenAPI .
            Get all kandi verified functions for this library.

            openapi-generator Key Features

            No Key Features are available at this moment for openapi-generator.

            openapi-generator Examples and Code Snippets

            No Code Snippets are available at this moment for openapi-generator.

            Community Discussions


            Despite Open API specification ASP.NET sees every property as mandatory
            Asked 2022-Apr-01 at 03:13

            I normally generate the server code directly in online service

            Going on I decided to add more automation so I decided to use the CLI tool with aspnetcore generator:

            This is the important part of the PowerShell script that triggers the generator:



            Answered 2022-Apr-01 at 03:13

            As this document said:

            Beginning with .NET 6, new projects include the enable element in the project file. Once the feature is turned on, existing reference variable declarations become non-nullable reference types.

            In .NET 6 the non-nullable property must be required, otherwise the ModelState will be invalid.

            To achieve your requirement, you can remove enable from your project file.

            Another way is that you can add ? to allow nullable:



            Is there a maven plugin that I can use to generate openapi spec file from JAX-RX source files
            Asked 2022-Mar-25 at 09:35

            I'm trying to generate openapi/swagger spec file during the build time. Maven plugin jaxrs-gen works but it's very old and no longer maintained and creates very old version of swagger spec file which is no longer compatible with the new versions. Please note that openapi-generator-maven-plugin which creates java client end points from spec file works as expected, but I am trying to do the other way round.



            Answered 2022-Mar-25 at 09:35

            I found SmallRye OpenAPI Maven Plugin which works as expected and is aligned to what I needed.



            How can I use golang generics in 1.18 to simplify the code snippet?
            Asked 2022-Mar-19 at 23:06

            I've been using 2 SDKs that were generated by OpenAPI generator in a separate packages that share an identical code that is duplicated in different packages foo, bar:



            Answered 2022-Mar-19 at 23:06

            You can change mainErrorModel to struct with no pointer with type assertion, then change that struct to struct with pointer, and finaly you can change again to type Failure interface with type assertion.

            this is the example.



            How to add basepath in OpenApi so that it is autogenerated with maven?
            Asked 2022-Mar-17 at 08:54

            I have a springboot project in which I have developed an api with OpenApi in yml format and autogenerated the classes with openapi-generator-maven-plugin. The yml is as follows:



            Answered 2022-Mar-17 at 08:54

            In my tests, it worked just fine. The my-path part got changed, matching the spec changes.



            Headers are not being shown in Swagger API documentation for Ktor API (Kotlin)
            Asked 2022-Mar-16 at 12:09

            I'm using the papsign/Ktor-OpenAPI-Generator to generate Swagger API documentation for a Ktor application. I have a POST endpoint which contains headers in the request. Here is the entire code:



            Answered 2022-Mar-16 at 12:09

            Found the error. The first parameter of post function is the class of header. Here is the updated code :-



            How to skip generation of ".openapi-generator" folder when using openapi-generator?
            Asked 2022-Mar-13 at 08:06

            I am not able in any way to skip openapi-generator maven plugin version 5.3.0 from generating ".openapi-generator" folder.



            Answered 2022-Mar-13 at 08:06

            It turns out that this file is generated at the maven-plugin level and is hard-coded to be generated.
            See source code.

            There is no supported way to skip it's generation currently.

            A possible option is creating your own plugin copied from openapi-generator-maven-plugin and remove the unwanted files generation.



            Argument of type 'Observable&Observable>&Observable>' is not assignable to 'Observable>'
            Asked 2022-Feb-28 at 13:21

            I am trying to connect the generated openapi-generator angular code with the JHipster CRUD views. I was trying to edit and tailor them together for the Pet entity, however, I get the following error:

            "Argument of type 'Observable & Observable & Observable' is not assignable to parameter of type 'Observable'."

            JHipster generates entities having models, services, and CRUD operations. The code generated by the OpenAPI generator has just service and model. I am trying to use the model and service from the OpenAPI gen in JHipster template. I have no idea what to change to remove the error. The code from the pet-update-component.ts, where I have problems with petService.updatePet(pet) and petService.addPet(pet):



            Answered 2022-Feb-28 at 13:21

            Okay, so what I did was commenting out methods declarations with Observable and "Observable>". I have different problems now but at least those are not highlighted in red anymore.



            OpenAPI Swagger Code Gen C# Server Stub Throws Exception
            Asked 2022-Feb-26 at 16:31

            I have used the following command to generate the C# server stub code from a Swagger Yaml file:



            Answered 2022-Feb-26 at 16:31

            Looks like you have a typo somewhere in the code. Can you do a "find all" (usually CTRL + SHIFT + F) and look for application.json and change it to application/json instead?



            Generate api and models in TS with openapi-generator-cli from multiple definitions from ocelote
            Asked 2022-Feb-19 at 16:30

            I'm trying to setup a dotnet micro-service backend with a gateway using Ocelote. Doing this as described, Ocelote provides me with multiple swagger definitions (for each micro-service)

            Since the API now has multiple definition, each definition has its own defining json file.

            How can i generate the API services and Models using openapi-generator-cli in this case. Previously i only had one definition which i generated with the command below, passing it the published json file directly



            Answered 2022-Feb-19 at 16:30

            Since there was no fitting tool for my problem or an answer for 6 months, i decided to write an open source tool myself. It is still a WIP but it may already be enough for you, just like it is for my current needs.

            Basically what it does is detecting the swagger definitions, generating each of those using the openapi-cli-generator and then merging all generated files together. At the end there are no duplicate files and a single Configuration.

            If you find any bugs or unhandled edge cases please contribute via Github!




            Is it possible to generate controller which returns void but not Void (object type) using Open API code generator in Java?
            Asked 2022-Feb-14 at 09:47

            I use open api generator (gradle's implementation) to generate controllers for my API in Java, but if my endpoint return nothing - OpenAPI generator generates return type as object type Void, but not as void.

            I expect:



            Answered 2022-Jan-28 at 15:51

            Let's consider the 5.3.1 version of openapi-generator as the current version.


            It does not seem to be feasible to force the generator to use the void return type instead of Void.

            As a last resort, it may be considered to create a fork of the generator and implement the desired behavior.

            Details Already requested feature

            The feature is already requested by the GitHub issue: Change return types for Spring openapi-generator-maven-plugin generated interfaces · Issue #6135 · OpenAPITools/openapi-generator.

            The related question: java - Change return types for Spring openapi-generator-maven-plugin generated interfaces - Stack Overflow.

            Source code

            The spring generator (generatorName: spring) is represented by the org.openapitools.codegen.languages.SpringCodegen class.

            The Void type detection is implemented by the SpringCodegen class.

            Please, see the related part of the source code: openapi-generator/ at v5.3.1 · OpenAPITools/openapi-generator:


            Community Discussions, Code Snippets contain sources that include Stack Exchange Network


            No vulnerabilities reported

            Install openapi-generator

            You can install using 'pip install openapi-generator' or download it from GitHub, GitLab, PyPI.
            You can use openapi-generator like any standard Java library. Please include the the jar files in your classpath. You can also use any IDE and you can run and debug the openapi-generator component as you would do with any other Java program. Best practice is to use a build tool that supports dependency management such as Maven or Gradle. For Maven installation, please refer For Gradle installation, please refer .


            For any new features, suggestions and bugs create an issue on GitHub. If you have any questions check and ask questions on community page Stack Overflow .
            Find more information at:

            Find, review, and download reusable Libraries, Code Snippets, Cloud APIs from over 650 million Knowledge Items

            Find more libraries
          • HTTPS


          • CLI

            gh repo clone OpenAPITools/openapi-generator

          • sshUrl


          • Stay Updated

            Subscribe to our newsletter for trending solutions and developer bootcamps

            Agree to Sign up and Terms & Conditions

            Share this Page

            share link