datamodel-code-generator

This code generator creates pydantic model from an openapi file and others.

license

Help

See documentation for more details.

Supported source types

OpenAPI 3 (YAML/JSON, OpenAPI Data Type)
JSON Schema (JSON Schema Core/JSON Schema Validation)
JSON/YAML/CSV Data (it will be converted to JSON Schema)
Python dictionary (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
email
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.)
$id (for JSONSchema)

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,dict,csv}]
                         [--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] [--use-standard-collections]
                         [--use-schema-description] [--reuse-model] [--class-name CLASS_NAME]
                         [--custom-template-dir CUSTOM_TEMPLATE_DIR]
                         [--extra-template-data EXTRA_TEMPLATE_DATA] [--aliases ALIASES]
                         [--target-python-version {3.6,3.7,3.8,3.9}]
                         [--validation] [--encoding ENCODING] [--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,dict,csv}
                        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
  --use-standard-collections
                        Use standard collections for type hinting (list, dict)
  --use-schema-description
                        Use schema description to populate class docstring
  --reuse-model         Re-use models on the field when a module has the model with the same content
  --class-name CLASS_NAME
                        Set class name of root model
  --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,3.8,3.9}
                        target python version (default: 3.7)
  --validation          Enable validation (Only OpenAPI)
  --encoding ENCODING   The encoding of input and output (default: utf-8)
  --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.

Metadata

Release files for datamodel-code-generator 0.6.21

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for datamodel-code-generator 0.6.21
File	Size	Uploaded
datamodel-code-generator-0.6.21.tar.gz	92.3 kB	Jan 18, 2021	Details

Built distribution (wheel)

Table of built distributions (wheels) for datamodel-code-generator 0.6.21
File	Interpreter	ABI	Platform	Reset
datamodel_code_generator-0.6.21-py3-none-any.whl 171.1 kB Jan 18, 2021	Python 3	none	any	Details

Total release size: 263.4 kB

Release files / datamodel-code-generator-0.6.21.tar.gz

Download URL	datamodel-code-generator-0.6.21.tar.gz
Size	92.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`73abdf4896651c678e39f48929abf2204ac5a8b1b8d4b58df57f13f41de45c22`
BLAKE2b-256 checksum How to use checksums	`6b4fbaf1ec64c7dc42bb93878163b1c01f54a1b62ec77859c7b9252ebf934bda`
Upload date	Jan 18, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7`

Release files / datamodel_code_generator-0.6.21-py3-none-any.whl

Download URL	datamodel_code_generator-0.6.21-py3-none-any.whl
Size	171.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`c2ccd0252eaebb5d3ba48951d016a8ac4286575d8d8314042d5d1b33025bf687`
BLAKE2b-256 checksum How to use checksums	`775d3bf27bd33b156de1c601e26d8a02f2ee0931b882e23473390201a1fdb678`
Upload date	Jan 18, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7`