koxudaxi / Datamodel Code Generator
Licence: mit
Pydantic model generator for easy conversion of JSON, OpenAPI, JSON Schema, and YAML data sources.
Stars: ✭ 393
Programming Languages
python
139335 projects - #7 most used programming language
Projects that are alternatives of or similar to Datamodel Code Generator
Swaggen
OpenAPI/Swagger 3.0 Parser and Swift code generator
Stars: ✭ 385 (-2.04%)
Mutual labels: swagger, openapi, yaml, generator
Spot
Spot is a concise, developer-friendly way to describe your API contract.
Stars: ✭ 230 (-41.48%)
Mutual labels: swagger, openapi, json-schema
Swagger meqa
Auto generate and run tests using swagger/OpenAPI spec, no coding needed
Stars: ✭ 151 (-61.58%)
Mutual labels: swagger, openapi, yaml
Autorest
OpenAPI (f.k.a Swagger) Specification code generator. Supports C#, PowerShell, Go, Java, Node.js, TypeScript, Python
Stars: ✭ 3,607 (+817.81%)
Mutual labels: swagger, openapi, code-generator
Api Client Generator
Angular REST API client generator from Swagger YAML or JSON file with camel case settigs
Stars: ✭ 92 (-76.59%)
Mutual labels: swagger, yaml, generator
Swurg
Parse OpenAPI documents into Burp Suite for automating OpenAPI-based APIs security assessments (approved by PortSwigger for inclusion in their official BApp Store).
Stars: ✭ 94 (-76.08%)
Mutual labels: swagger, openapi, yaml
php-json-schema-model-generator
Creates (immutable) PHP model classes from JSON-Schema files including all validation rules as PHP code
Stars: ✭ 36 (-90.84%)
Mutual labels: code-generator, json-schema, openapi
Apispec
A pluggable API specification generator. Currently supports the OpenAPI Specification (f.k.a. the Swagger specification)..
Stars: ✭ 831 (+111.45%)
Mutual labels: swagger, openapi, json-schema
openapi-schemas
JSON Schemas for every version of the OpenAPI Specification
Stars: ✭ 22 (-94.4%)
Mutual labels: json-schema, swagger, openapi
json-ref-resolver
[Deprecated] Recursively resolve JSON pointers and remote authorities.
Stars: ✭ 27 (-93.13%)
Mutual labels: json-schema, swagger, openapi
modelina
Library for generating data models based on inputs such as AsyncAPI, OpenAPI, or JSON Schema documents.
Stars: ✭ 55 (-86.01%)
Mutual labels: generator, json-schema, openapi
Openapi Mock Generator
Progressive Web App for generating mocked data from an OpenAPI specification
Stars: ✭ 72 (-81.68%)
Mutual labels: swagger, openapi, generator
Fastapi
FastAPI framework, high performance, easy to learn, fast to code, ready for production
Stars: ✭ 39,588 (+9973.28%)
Mutual labels: swagger, openapi, json-schema
Kaizen Openapi Editor
Eclipse Editor for the Swagger-OpenAPI Description Language
Stars: ✭ 97 (-75.32%)
Mutual labels: swagger, openapi, yaml
Spectral
A flexible JSON/YAML linter for creating automated style guides, with baked in support for OpenAPI v2 & v3.
Stars: ✭ 876 (+122.9%)
Mutual labels: swagger, openapi, json-schema
Full Stack Fastapi Couchbase
Full stack, modern web application generator. Using FastAPI, Couchbase as database, Docker, automatic HTTPS and more.
Stars: ✭ 243 (-38.17%)
Mutual labels: swagger, openapi, json-schema
Full Stack Fastapi Postgresql
Full stack, modern web application generator. Using FastAPI, PostgreSQL as database, Docker, automatic HTTPS and more.
Stars: ✭ 7,635 (+1842.75%)
Mutual labels: swagger, openapi, json-schema
Swagger Parser
Swagger 2.0 and OpenAPI 3.0 parser/validator
Stars: ✭ 710 (+80.66%)
Mutual labels: swagger, openapi, json-schema
fhir-fuel.github.io
Place to prepare proposal to FHIR about JSON, JSON-Schema, Swagger/OpenAPI, JSON native databases and other JSON-frendly formats (yaml, edn, avro, protobuf etc) and technologies
Stars: ✭ 20 (-94.91%)
Mutual labels: json-schema, swagger, openapi
Openapi Typescript Codegen
NodeJS library that generates Typescript or Javascript clients based on the OpenAPI specification
Stars: ✭ 249 (-36.64%)
Mutual labels: swagger, openapi, generator
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, 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
- uuid (uuid1/uuid2/uuid3/uuid4/uuid5)
- ipv4
- ipv6
- hostname
- decimal
Other schema
- enum (as enum.Enum or typing.Literal)
- allOf (as Multiple inheritance)
- anyOf (as typing.Union)
- oneOf (as typing.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] [--url URL] [--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] [--disable-appending-item-suffix]
[--allow-population-by-field-name] [--enable-faux-immutability] [--use-default] [--force-optional] [--strict-nullable]
[--disable-timestamp] [--use-standard-collections] [--use-generic-container-types] [--use-schema-description]
[--reuse-model] [--enum-field-as-literal {all,one}] [--set-default-enum-member] [--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)
--url URL Input file URL. `--input` is ignore when `--url` is used
--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
--disable-appending-item-suffix
Disable appending `Item` suffix to model name in an array
--allow-population-by-field-name
Allow population by field name
--enable-faux-immutability
Enable faux immutability
--use-default Use default value even if a field is required
--force-optional Force optional for required fields
--strict-nullable Treat default field as a non-nullable field (only OpenAPI)
--disable-timestamp Disable timestamp on file headers
--use-standard-collections
Use standard collections for type hinting (list, dict)
--use-generic-container-types
Use generic container types for type hinting (typing.Sequence, typing.Mapping). If `--use-standard-
collections` option is set, then import from collections.abc instead of typing
--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
--enum-field-as-literal {all,one}
Parse enum field as literal. all: all enum field type are Literal. one: field type is Literal when an enum has only
one possible value
--set-default-enum-member
Set enum members as default values for enum field
--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
# Generate models from a local file.
$ datamodel-codegen --input api.yaml --output model.py
# or directly from a URL.
$ datamodel-codegen --url https://<INPUT FILE URL> --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]
Related projects
fastapi-code-generator
This code generator creates FastAPI app from an openapi file.
https://github.com/koxudaxi/fastapi-code-generator
pydantic-pycharm-plugin
A JetBrains PyCharm plugin for pydantic
.
https://github.com/koxudaxi/pydantic-pycharm-plugin
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
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].