Handle YAML data in FastAPI
Project description
Overview
Handle YAML requests with FastAPI.
Installation
pip install fastapi-yaml
Usage
FastAPI Code:
from fastapi import FastAPI
from fastapi_yaml import YamlRoute
from pydantic import BaseModel
app = FastAPI()
app.router.route_class = YamlRoute
class Person(BaseModel, extra='forbid'):
name: str
age: int
@app.post("/person")
def person(person: Person):
return f"{person.name} is {person.age} years old"
HTTP Request:
curl --request POST \
--url http://localhost:8000/person \
--header "content-type: application/x-yaml" \
--data "name: John Doe\nage: 42"
Tests
poetry run pytest --cov fastapi_yaml tests/
Coverage
---------- coverage: platform darwin, python 3.11.2-final-0 ----------
Name Stmts Miss Cover
----------------------------------------------
fastapi_yaml/__init__.py 1 0 100%
fastapi_yaml/main.py 20 0 100%
----------------------------------------------
TOTAL 21 0 100%
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
fastapi_yaml-0.1.2.tar.gz
(1.8 kB
view hashes)
Built Distribution
Close
Hashes for fastapi_yaml-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf412db8d4db1e119b6dec263816ab9b822ab34c418249d9b8764c98b6f22d09 |
|
MD5 | 9358eac4159acbb432890c4cdb83ff6c |
|
BLAKE2b-256 | f1415d8902e85a3d2bb8d5ebd5842bedbad76c32a55fd9a873360bb8e6012612 |