https://github.com/openapi-json-schema-tools/openapi-python-client-comparison

openapi python client comparison
https://github.com/openapi-json-schema-tools/openapi-python-client-comparison

Last synced: 2 months ago
JSON representation

openapi python client comparison

• Host: GitHub
• URL: https://github.com/openapi-json-schema-tools/openapi-python-client-comparison
• Owner: openapi-json-schema-tools
• License: mit
• Created: 2023-04-24T06:03:31.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-05-10T00:11:06.000Z (almost 2 years ago)
• Last Synced: 2025-01-06T14:30:13.421Z (4 months ago)
• Language: Python
• Size: 332 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# openapi-python-client-comparison

openapi python client comparison

A repo to compare openapi python clients

## Implementations Included

- [swagger-codegen](https://github.com/swagger-api/swagger-codegen), python generator

- [openapi-generator](https://github.com/OpenAPITools/openapi-generator)

  - python-prior generator

  - python-nextgen

- [openapi-json-schema-generator](https://github.com/openapi-json-schema-tools/openapi-json-schema-generator), python generator

## Openapi Documents and Purposes

| Document | Purpose | Provenance |

| -------- | ------- | ---------- |

| petstore.yaml | standard api | [openapi-generator repo](https://github.com/OpenAPITools/openapi-generator/blob/917892db7d1dc5a459bdf6d499a491367fc97751/modules/openapi-generator/src/test/resources/3_0/petstore.yaml)

## Generated Code Amount

via vscode code counter tool

### petstore.yaml

| Generator | Files | Code |

| -------- | ----- | ---- |

| openapi_generator_python_nextgen | 28 | 2781 |

| openapi_generator_python_prior | 30 | 5075 |

| openapi_json_schema_generator_python | 365 | 8737

### openapi_json_schema_generator_python breakdown

- 3.9k src/openapi_client/paths

  - ~ 50% of this is in operation.py

- 3.3k 7 files in src/openapi_client

  - api_client.py + schemas.py are big

- most of this comes from the 3x operation typing overloads

Reasons for the openapi json scheme generator difference

- has overload type hints on all endpoints, allows input content type selection

- json paths used to create files so many files made

## Generate

docker run --rm -v ${PWD}:/local swaggerapi/swagger-codegen-cli:2.4.31 generate \

    -i /local/petstore.yaml \

    -l python \

    -o /local/swagger_codegen_python

docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli:v6.5.0 generate \

    -i /local/petstore.yaml \

    -g python-prior \

    -o /local/openapi_generator_python_prior

docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli generate \

    -i /local/petstore.yaml \

    -g python-nextgen \

    -o /local/openapi_generator_python_nextgen

docker run --rm -v "${PWD}:/local" openapijsonschematools/openapi-json-schema-generator-cli:3.0.0-latest generate \

    -i /local/petstore.yaml \

    -g python \

    -o /local/openapi_json_schema_generator_python

/Users/justinblack/programming/openapi-python-client-comparison/petstore/openapi_generator_python_prior/