This code generator creates pydantic model from an openapi file.
- OpenAPI 3 (yaml/json)
- string (include patter/minLength/maxLenght)
- number (include maximum/exclusiveMaximum/minimum/exclusiveMinimum/multipleOf/le/ge)
- integer (include maximum/exclusiveMaximum/minimum/exclusiveMinimum/multipleOf/le/ge)
- boolean
- array
- object
- date
- datetime
- password
- uuid (uuid1/uuid2/uuid3/uuid4/uuid5)
- ipv4
- ipv6
- enum
- allOf (as Multiple inheritance)
- anyOf (as Union)
- $ref (only one file)
To install datamodel-code-generator:
$ pip install datamodel-code-generatorThe datamodel-codegen command:
usage: datamodel-codegen [-h] [--input INPUT] [--output OUTPUT]
[--base-class BASE_CLASS]
[--custom-template-dir CUSTOM_TEMPLATE_DIR]
[--extra-template-data EXTRA_TEMPLATE_DATA]
[--target-python-version {3.6,3.7}] [--debug]
[--version]
optional arguments:
-h, --help show this help message and exit
--input INPUT Open API YAML file (default: stdin)
--output OUTPUT Output file (default: stdout)
--base-class BASE_CLASS
Base Class (default: pydantic.BaseModel)
--custom-template-dir CUSTOM_TEMPLATE_DIR
Custom Template Directory
--extra-template-data EXTRA_TEMPLATE_DATA
Extra Template Data
--target-python-version {3.6,3.7}
target python version (default: 3.7)
--debug show debug message
--version show version
Code generated by datamodel-codegen will be passed through isort and
black to produce consistent, well-formatted results. Settings for these tools
can be specified in pyproject.toml (located in the output directory, or in
some parent of the output directory).
Example pyproject.toml:
[tool.black]
string-normalization = true
line-length = 100
[tool.isort]
multi_line_output = 3
include_trailing_comma = true
force_grid_wrap = 0
use_parentheses = true
line_length = 100
known_first_party = "kelvin"See the Black Project for more information.
$ datamodel-codegen --input api.yaml --output model.pyapi.yaml
```yaml
openapi: "3.0.0"
info:
version: 1.0.0
title: Swagger Petstore
license:
name: MIT
servers:
- url: http://petstore.swagger.io/v1
paths:
/pets:
get:
summary: List all pets
operationId: listPets
tags:
- pets
parameters:
- name: limit
in: query
description: How many items to return at one time (max 100)
required: false
schema:
type: integer
format: int32
responses:
'200':
description: A paged array of pets
headers:
x-next:
description: A link to the next page of responses
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/Pets"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${PythonVersionFunction.Arn}/invocations
passthroughBehavior: when_no_templates
httpMethod: POST
type: aws_proxy
post:
summary: Create a pet
operationId: createPets
tags:
- pets
responses:
'201':
description: Null response
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${PythonVersionFunction.Arn}/invocations
passthroughBehavior: when_no_templates
httpMethod: POST
type: aws_proxy
/pets/{petId}:
get:
summary: Info for a specific pet
operationId: showPetById
tags:
- pets
parameters:
- name: petId
in: path
required: true
description: The id of the pet to retrieve
schema:
type: string
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: "#/components/schemas/Pets"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
x-amazon-apigateway-integration:
uri:
Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${PythonVersionFunction.Arn}/invocations
passthroughBehavior: when_no_templates
httpMethod: POST
type: aws_proxy
components:
schemas:
Pet:
required:
- id
- name
properties:
id:
type: integer
format: int64
name:
type: string
tag:
type: string
Pets:
type: array
items:
$ref: "#/components/schemas/Pet"
Error:
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string
apis:
type: array
items:
type: object
properties:
apiKey:
type: string
description: To be used as a dataset parameter value
apiVersionNumber:
type: string
description: To be used as a version parameter value
apiUrl:
type: string
format: uri
description: "The URL describing the dataset's fields"
apiDocumentationUrl:
type: string
format: uri
description: A URL to the API console for each API
```
model.py:
# generated by datamodel-codegen:
# filename: api.yaml
# timestamp: 2019-09-26T01:04:25+00:00
from __future__ import annotations
from typing import List, Optional
from pydantic import BaseModel, UrlStr
class Pet(BaseModel):
id: int
name: str
tag: Optional[str] = None
class Pets(BaseModel):
__root__: List[Pet]
class Error(BaseModel):
code: int
message: str
class api(BaseModel):
apiKey: Optional[str] = None
apiVersionNumber: Optional[str] = None
apiUrl: Optional[UrlStr] = None
apiDocumentationUrl: Optional[UrlStr] = None
class apis(BaseModel):
__root__: List[api]Install the package in editable mode:
$ git clone git@github.com:koxudaxi/datamodel-code-generator.git
$ pip install -e datamodel-code-generatorWe are waiting for your contributions to datamodel-code-generator.
## 1. Clone your fork repository
$ git clone git@github.com:<your username>/datamodel-code-generator.git
$ cd datamodel-code-generator
## 2. Create `venv` with python3.7 (also you should do with python3.6)
$ python3.7 -m venv venv37
$ source venv37/bin/activate
## 3. Install dependencies
$ python3 -m pip install ".[all]"
## 4. Create new branch and rewrite code.
$ git checkout -b new-branch
## 5. Run unittest (you should pass all test and coverage should be 100%)
$ ./scripts/test.sh
## 6. Format code
$ ./scripts/format.sh
## 7. Check lint (mypy)
$ ./scripts/lint.sh
## 8. Commit and Push...https://pypi.org/project/datamodel-code-generator
https://github.com/koxudaxi/datamodel-code-generator
https://koxudaxi.github.io/datamodel-code-generator
datamodel-code-generator is released under the MIT License. http://www.opensource.org/licenses/mit-license