Datamodel Code Generator
Project description
datamodel-code-generator
This code generator creates pydantic model from an openapi file and others.
Help
See documentation for more details.
Supported source types
- OpenAPI 3 (YAML/JSON)
- JSON Schema
- JSON/YAML Data (it will be converted to JSON Schema)
Implemented list
OpenAPI 3 and JsonSchema
DataType
- 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
String Format
- date
- datetime
- password
- uuid (uuid1/uuid2/uuid3/uuid4/uuid5)
- ipv4
- ipv6
- hostname
- decimal
Other schema
- enum
- allOf (as Multiple inheritance)
- anyOf (as Union)
- oneOf (as Union)
- $ref (http extra is required when resolving $ref for remote files.)
Installation
To install datamodel-code-generator
:
$ pip install datamodel-code-generator
http
extra option
If you want to resolve $ref
for remote files then you should specify http
extra option.
$ pip install datamodel-code-generator[http]
Usage
The datamodel-codegen
command:
usage: datamodel-codegen [-h] [--input INPUT]
[--input-file-type {auto,openapi,jsonschema,json,yaml}]
[--output OUTPUT] [--base-class BASE_CLASS]
[--field-constraints] [--snake-case-field]
[--strip-default-none]
[--allow-population-by-field-name] [--use-default]
[--force-optional] [--disable-timestamp]
[--custom-template-dir CUSTOM_TEMPLATE_DIR]
[--extra-template-data EXTRA_TEMPLATE_DATA]
[--aliases ALIASES]
[--target-python-version {3.6,3.7}] [--validation]
[--debug] [--version]
optional arguments:
-h, --help show this help message and exit
--input INPUT Input file/directory (default: stdin)
--input-file-type {auto,openapi,jsonschema,json,yaml}
Input file type (default: auto)
--output OUTPUT Output file (default: stdout)
--base-class BASE_CLASS
Base Class (default: pydantic.BaseModel)
--field-constraints Use field constraints and not con* annotations
--snake-case-field Change camel-case field name to snake-case
--strip-default-none Strip default None on fields
--allow-population-by-field-name
Allow population by field name
--use-default Use default value even if a field is required
--force-optional Force optional for required fields
--disable-timestamp Disable timestamp on file headers
--custom-template-dir CUSTOM_TEMPLATE_DIR
Custom template directory
--extra-template-data EXTRA_TEMPLATE_DATA
Extra template data
--aliases ALIASES Alias mapping file
--target-python-version {3.6,3.7}
target python version (default: 3.7)
--validation Enable validation (Only OpenAPI)
--debug show debug message
--version show version
Example
OpenAPI
$ datamodel-codegen --input api.yaml --output model.py
api.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: 2020-06-02T05:28:24+00:00
from __future__ import annotations
from typing import List, Optional
from pydantic import AnyUrl, BaseModel, Field
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] = Field(
None, description='To be used as a dataset parameter value'
)
apiVersionNumber: Optional[str] = Field(
None, description='To be used as a version parameter value'
)
apiUrl: Optional[AnyUrl] = Field(
None, description="The URL describing the dataset's fields"
)
apiDocumentationUrl: Optional[AnyUrl] = Field(
None, description='A URL to the API console for each API'
)
class Apis(BaseModel):
__root__: List[Api]
PyPi
https://pypi.org/project/datamodel-code-generator
License
datamodel-code-generator is released under the MIT License. http://www.opensource.org/licenses/mit-license
This project is an experimental phase.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for datamodel-code-generator-0.6.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38aa7525be95bb582cc32b3e0e450119158481efdfca7860357258cbe2a94be8 |
|
MD5 | f6e6efc3aea17913a74b6f72f37131b7 |
|
BLAKE2b-256 | 08238b236f65b311f1ca6c7e01872044bc96eca24a6b1bf3b84a7e2e21dcc324 |
Close
Hashes for datamodel_code_generator-0.6.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 22eea293cac97b5525e1f03060f291019b165ae62da70b3f279edb3bec1325fb |
|
MD5 | 675d99f6be34fb2b9fcb172449b6b044 |
|
BLAKE2b-256 | 322008cece88015a5b7666900ab81a7e346f0dffb04fc3b6a0c2e7adc72ef589 |