fastapi-code-generator
This code generator creates FastAPI app from an openapi file.
This project is an experimental phase.
fastapi-code-generator uses datamodel-code-generator to generate pydantic models
Help
See documentation for more details.
Installation
To install fastapi-code-generator:
$ pip install fastapi-code-generator
Usage
The fastapi-code-generator command:
Usage: fastapi-codegen [OPTIONS]
Options:
-i, --input FILENAME [required]
-o, --output PATH [required]
-t, --template-dir PATH
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it
or customize the installation.
--help Show this message and exit.
Example
OpenAPI
$ fastapi-codegen --input api.yaml --output app
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
description: list of pet
items:
$ref: "#/components/schemas/Pet"
Error:
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string
app/main.py:
# generated by fastapi-codegen:
# filename: api.yaml
# timestamp: 2020-06-14T10:45:22+00:00
from __future__ import annotations
from typing import Optional
from fastapi import FastAPI, Query
from .models import Pets
app = FastAPI(version="1.0.0", title="Swagger Petstore", license="{'name': 'MIT'}",)
@app.get('/pets', response_model=Pets)
def list_pets(limit: Optional[int] = None) -> Pets:
"""
List all pets
"""
pass
@app.post('/pets', response_model=None)
def create_pets() -> None:
"""
Create a pet
"""
pass
@app.get('/pets/{pet_id}', response_model=Pets)
def show_pet_by_id(pet_id: str = Query(..., alias='petId')) -> Pets:
"""
Info for a specific pet
"""
pass
app/models.py:
# generated by datamodel-codegen:
# filename: api.yaml
# timestamp: 2020-06-14T10:45:22+00:00
from typing import List, Optional
from pydantic import BaseModel, Field
class Pet(BaseModel):
id: int
name: str
tag: Optional[str] = None
class Pets(BaseModel):
__root__: List[Pet] = Field(..., description='list of pet')
class Error(BaseModel):
code: int
message: str
Custom Template
If you want to generate custom *.py files then you can give custom template directory fastapi-code-generator as -t or --template-dir options of the command.
fastapi-code-generator search jinja2 template files in given template directory.
These files will be rendered and write to the output directory. Also, the generated file name will be created template file name which extension is replace to *.py.
Variables
You can use below variables in jinja2 template
importsall imports statementsinfoall info statementsoperationsoperationsis list ofoperationoperation.typeHTTP METHODoperation.pathPathoperation.snake_case_pathSnake-cased Pathoperation.responseresponse objectoperation.function_namefunction name is createdoperationIdorMETHOD+Pathoperation.snake_case_argumentsSnake-cased function argumentsoperation.securitySecurityoperation.summarya summary
default template
main.jinja2
from __future__ import annotations
from fastapi import FastAPI
{{imports}}
app = FastAPI(
{% if info %}
{% for key,value in info.items() %}
{{ key }} = "{{ value }}",
{% endfor %}
{% endif %}
)
{% for operation in operations %}
@app.{{operation.type}}('{{operation.snake_case_path}}', response_model={{operation.response}})
def {{operation.function_name}}({{operation.snake_case_arguments}}) -> {{operation.response}}:
{%- if operation.summary %}
"""
{{ operation.summary }}
"""
{%- endif %}
pass
{% endfor %}
PyPi
https://pypi.org/project/fastapi-code-generator
License
fastapi-code-generator is released under the MIT License. http://www.opensource.org/licenses/mit-license
14 May 02, 2021
379 Jan 03, 2023
543 Jan 05, 2023
351 Jan 04, 2023
2.3k Dec 30, 2022
5 Jan 07, 2023
4 Jan 28, 2021
283 Jan 04, 2023
6 Nov 13, 2022
54 Nov 26, 2022
58 Dec 14, 2022
5 Mar 14, 2022
1 Feb 11, 2022
91 Jan 05, 2023
4.9k Jan 03, 2023
310 Dec 14, 2022
871 Dec 25, 2022
74 Dec 30, 2022
4 Mar 16, 2022
96 Jan 02, 2023