datamodel-code-generator
This generator creates pydantic mode from an openapi file.
This project is an experimental phase.
Installation
To install datamodel-code-generator:
$ pip install datamodel-code-generator
Usage
The datamodel-codegen command:
usage: datamodel-codegen [-h] [--input INPUT] [--output OUTPUT]
optional arguments:
-h, --help show this help message and exit
--input INPUT Open API YAML file
--output OUTPUT Output file
Example
$ datamodel-codegen --input api.yaml --output model.py
api.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: uriref
# description: "The URL describing the dataset's fields"
# apiDocumentationUrl:
# type: string
# format: uriref
# description: A URL to the API console for each API
model.py:
# generated by datamodel-codegen:
# filename: api.yaml
# timestamp: 2019-07-23T14:23:18+00:00
from typing import List, Optional
from pydantic import BaseModel
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
class apis(BaseModel):
__root__: List[api]
Development
Install the package in editable mode:
$ git clone git@github.com:koxudaxi/datamodel-code-generator.git
$ pip install -e datamodel-code-generator
PyPi
https://pypi.org/project/datamodel-code-generator
Source Code
https://github.com/koxudaxi/datamodel-code-generator
Documentation
https://koxudaxi.github.io/datamodel-code-generator
License
datamodel-code-generator is released under the MIT License. http://www.opensource.org/licenses/mit-license
2 maintainers
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file datamodel-code-generator-0.0.4.tar.gz.
File metadata
- Download URL: datamodel-code-generator-0.0.4.tar.gz
- Upload date:
- Size: 14.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a82054cadd06ec95baa08ab7f185b66d57f3fa50c1399904e3a8db0858de3d77
|
|
| MD5 |
74f5e92a2f3685b07ae81cf7c56b9e2d
|
|
| BLAKE2b-256 |
f4637883b0d6ab6a1fb690cfe0cf2bd0743994992bf3710e56b8c8bb0ae6d04b
|
File details
Details for the file datamodel_code_generator-0.0.4-py3-none-any.whl.
File metadata
- Download URL: datamodel_code_generator-0.0.4-py3-none-any.whl
- Upload date:
- Size: 12.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9acd61d0a07c44a435de9cde813cf751fe1a8c5167effb5e8ba4ae22f3c5aeb1
|
|
| MD5 |
39da3a5dc60f8bbbfd995f3f62191569
|
|
| BLAKE2b-256 |
fc084056972f714470a220e38f577957e950306402e73d3bc874c8c313550be1
|
