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

Add TOC and a new section in the migration guide (#174)

Browse Source
This commit is contained in:
William Cheng 2018-05-29 19:29:54 +08:00 committed by GitHub
parent 31b9362433
commit ad5d5f598e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/migration-from-swagger-codegen.md
View File

@ -4,6 +4,22 @@ OpenAPI Generator is a fork of `swagger-codegen` between version `2.3.1` and `2.
This community-driven version called "OpenAPI Generator" provides similar functionalities and can be used as drop-in replacement.
This guide explains the major differences in order to help you with the migration.
**Table of contents**
- [New docker images](#new-docker-images)
- [New maven coordinates](#new-maven-coordinates)
- [Changes in Maven Plugin](#changes-in-maven-plugin)
- [New generators names](#new-generators-names)
- [New parameters name](#new-parameters-name)
- [Renamed Mustache Template Variables](#renamed-mustache-template-variables)
- [Ignore file](#ignore-file)
- [metadata-folder](#metadata-folder)
- [New default values for the generated code](#new-default-values-for-the-generated-code)
- [New fully qualified name for the classes](#new-fully-qualified-name-for-the-classes)
- [Body parameter name](#body-parameter-name)
- [Generators not yet fully migrated](#generators-not-yet-fully-migrated)
### New docker images
The docker images are available on DockerHub: https://hub.docker.com/u/openapitools/
@ -226,4 +242,14 @@ paths:
```
If your API client is using named parameters in the function call (e.g. Perl required & optional parameters, Ruby optional parameters), you will need to add `x-codegen-request-body-name` to the spec to restore the original body parameter name.
# Generators not yet fully migrated
The following gnereators are not yet fully migrated and tested
- `rust-server`
- `apex`
and we welcome contributions from the community to help with the migration
[Back to OpenAPI-Generator's README page](../README.md)