David Kadaria
7 months ago
committed by
GitHub
GitHub
55 changed files with 3232 additions and 283 deletions
|
After Width: | Height: | Size: 43 KiB |
@ -0,0 +1,134 @@ |
|||||
|
# Form Models |
||||
|
|
||||
|
You can use **Pydantic models** to declare **form fields** in FastAPI. |
||||
|
|
||||
|
/// info |
||||
|
|
||||
|
To use forms, first install <a href="https://github.com/Kludex/python-multipart" class="external-link" target="_blank">`python-multipart`</a>. |
||||
|
|
||||
|
Make sure you create a [virtual environment](../virtual-environments.md){.internal-link target=_blank}, activate it, and then install it, for example: |
||||
|
|
||||
|
```console |
||||
|
$ pip install python-multipart |
||||
|
``` |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
/// note |
||||
|
|
||||
|
This is supported since FastAPI version `0.113.0`. 🤓 |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
## Pydantic Models for Forms |
||||
|
|
||||
|
You just need to declare a **Pydantic model** with the fields you want to receive as **form fields**, and then declare the parameter as `Form`: |
||||
|
|
||||
|
//// tab | Python 3.9+ |
||||
|
|
||||
|
```Python hl_lines="9-11 15" |
||||
|
{!> ../../../docs_src/request_form_models/tutorial001_an_py39.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Python 3.8+ |
||||
|
|
||||
|
```Python hl_lines="8-10 14" |
||||
|
{!> ../../../docs_src/request_form_models/tutorial001_an.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Python 3.8+ non-Annotated |
||||
|
|
||||
|
/// tip |
||||
|
|
||||
|
Prefer to use the `Annotated` version if possible. |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
```Python hl_lines="7-9 13" |
||||
|
{!> ../../../docs_src/request_form_models/tutorial001.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
**FastAPI** will **extract** the data for **each field** from the **form data** in the request and give you the Pydantic model you defined. |
||||
|
|
||||
|
## Check the Docs |
||||
|
|
||||
|
You can verify it in the docs UI at `/docs`: |
||||
|
|
||||
|
<div class="screenshot"> |
||||
|
<img src="/img/tutorial/request-form-models/image01.png"> |
||||
|
</div> |
||||
|
|
||||
|
## Forbid Extra Form Fields |
||||
|
|
||||
|
In some special use cases (probably not very common), you might want to **restrict** the form fields to only those declared in the Pydantic model. And **forbid** any **extra** fields. |
||||
|
|
||||
|
/// note |
||||
|
|
||||
|
This is supported since FastAPI version `0.114.0`. 🤓 |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
You can use Pydantic's model configuration to `forbid` any `extra` fields: |
||||
|
|
||||
|
//// tab | Python 3.9+ |
||||
|
|
||||
|
```Python hl_lines="12" |
||||
|
{!> ../../../docs_src/request_form_models/tutorial002_an_py39.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Python 3.8+ |
||||
|
|
||||
|
```Python hl_lines="11" |
||||
|
{!> ../../../docs_src/request_form_models/tutorial002_an.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
//// tab | Python 3.8+ non-Annotated |
||||
|
|
||||
|
/// tip |
||||
|
|
||||
|
Prefer to use the `Annotated` version if possible. |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
```Python hl_lines="10" |
||||
|
{!> ../../../docs_src/request_form_models/tutorial002.py!} |
||||
|
``` |
||||
|
|
||||
|
//// |
||||
|
|
||||
|
If a client tries to send some extra data, they will receive an **error** response. |
||||
|
|
||||
|
For example, if the client tries to send the form fields: |
||||
|
|
||||
|
* `username`: `Rick` |
||||
|
* `password`: `Portal Gun` |
||||
|
* `extra`: `Mr. Poopybutthole` |
||||
|
|
||||
|
They will receive an error response telling them that the field `extra` is not allowed: |
||||
|
|
||||
|
```json |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "extra_forbidden", |
||||
|
"loc": ["body", "extra"], |
||||
|
"msg": "Extra inputs are not permitted", |
||||
|
"input": "Mr. Poopybutthole" |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
## Summary |
||||
|
|
||||
|
You can use Pydantic models to declare form fields in FastAPI. 😎 |
||||
@ -0,0 +1,28 @@ |
|||||
|
# Full Stack FastAPI 템플릿 |
||||
|
|
||||
|
템플릿은 일반적으로 특정 설정과 함께 제공되지만, 유연하고 커스터마이징이 가능하게 디자인 되었습니다. 이 특성들은 여러분이 프로젝트의 요구사항에 맞춰 수정, 적용을 할 수 있게 해주고, 템플릿이 완벽한 시작점이 되게 해줍니다. 🏁 |
||||
|
|
||||
|
많은 초기 설정, 보안, 데이터베이스 및 일부 API 엔드포인트가 이미 준비되어 있으므로, 여러분은 이 템플릿을 (프로젝트를) 시작하는 데 사용할 수 있습니다. |
||||
|
|
||||
|
GitHub 저장소: <a href="https://github.com/tiangolo/full-stack-fastapi-template" class="external-link" target="_blank">Full Stack FastAPI 템플릿</a> |
||||
|
|
||||
|
## Full Stack FastAPI 템플릿 - 기술 스택과 기능들 |
||||
|
|
||||
|
- ⚡ [**FastAPI**](https://fastapi.tiangolo.com): Python 백엔드 API. |
||||
|
- 🧰 [SQLModel](https://sqlmodel.tiangolo.com): Python SQL 데이터 상호작용을 위한 (ORM). |
||||
|
- 🔍 [Pydantic](https://docs.pydantic.dev): FastAPI에 의해 사용되는, 데이터 검증과 설정관리. |
||||
|
- 💾 [PostgreSQL](https://www.postgresql.org): SQL 데이터베이스. |
||||
|
- 🚀 [React](https://react.dev): 프론트엔드. |
||||
|
- 💃 TypeScript, hooks, Vite 및 기타 현대적인 프론트엔드 스택을 사용. |
||||
|
- 🎨 [Chakra UI](https://chakra-ui.com): 프론트엔드 컴포넌트. |
||||
|
- 🤖 자동으로 생성된 프론트엔드 클라이언트. |
||||
|
- 🧪 E2E 테스트를 위한 Playwright. |
||||
|
- 🦇 다크 모드 지원. |
||||
|
- 🐋 [Docker Compose](https://www.docker.com): 개발 환경과 프로덕션(운영). |
||||
|
- 🔒 기본으로 지원되는 안전한 비밀번호 해싱. |
||||
|
- 🔑 JWT 토큰 인증. |
||||
|
- 📫 이메일 기반 비밀번호 복구. |
||||
|
- ✅ [Pytest]를 이용한 테스트(https://pytest.org). |
||||
|
- 📞 [Traefik](https://traefik.io): 리버스 프록시 / 로드 밸런서. |
||||
|
- 🚢 Docker Compose를 이용한 배포 지침: 자동 HTTPS 인증서를 처리하기 위한 프론트엔드 Traefik 프록시 설정 방법을 포함. |
||||
|
- 🏭 GitHub Actions를 기반으로 CI (지속적인 통합) 및 CD (지속적인 배포). |
||||
@ -0,0 +1,201 @@ |
|||||
|
# Functionaliteit |
||||
|
|
||||
|
## FastAPI functionaliteit |
||||
|
|
||||
|
**FastAPI** biedt je het volgende: |
||||
|
|
||||
|
### Gebaseerd op open standaarden |
||||
|
|
||||
|
* <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank"><strong>OpenAPI</strong></a> voor het maken van API's, inclusief declaraties van <abbr title="ook bekend als: endpoints, routess">pad</abbr><abbr title="ook bekend als HTTP-methoden, zoals POST, GET, PUT, DELETE">bewerkingen</abbr>, parameters, request bodies, beveiliging, enz. |
||||
|
* Automatische datamodel documentatie met <a href="https://json-schema.org/" class="external-link" target="_blank"><strong>JSON Schema</strong></a> (aangezien OpenAPI zelf is gebaseerd op JSON Schema). |
||||
|
* Ontworpen op basis van deze standaarden, na zorgvuldig onderzoek. In plaats van achteraf deze laag er bovenop te bouwen. |
||||
|
* Dit maakt het ook mogelijk om automatisch **clientcode te genereren** in verschillende programmeertalen. |
||||
|
|
||||
|
### Automatische documentatie |
||||
|
|
||||
|
Interactieve API-documentatie en verkenning van webgebruikersinterfaces. Aangezien dit framework is gebaseerd op OpenAPI, zijn er meerdere documentatie opties mogelijk, waarvan er standaard 2 zijn inbegrepen. |
||||
|
|
||||
|
* <a href="https://github.com/swagger-api/swagger-ui" class="external-link" target="_blank"><strong>Swagger UI</strong></a>, met interactieve interface, maakt het mogelijk je API rechtstreeks vanuit de browser aan te roepen en te testen. |
||||
|
|
||||
|
 |
||||
|
|
||||
|
* Alternatieve API-documentatie met <a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank"><strong>ReDoc</strong></a>. |
||||
|
|
||||
|
 |
||||
|
|
||||
|
### Gewoon Moderne Python |
||||
|
|
||||
|
Het is allemaal gebaseerd op standaard **Python type** declaraties (dankzij Pydantic). Je hoeft dus geen nieuwe syntax te leren. Het is gewoon standaard moderne Python. |
||||
|
|
||||
|
Als je een opfriscursus van 2 minuten nodig hebt over het gebruik van Python types (zelfs als je FastAPI niet gebruikt), bekijk dan deze korte tutorial: [Python Types](python-types.md){.internal-link target=_blank}. |
||||
|
|
||||
|
Je schrijft gewoon standaard Python met types: |
||||
|
|
||||
|
```Python |
||||
|
from datetime import date |
||||
|
|
||||
|
from pydantic import BaseModel |
||||
|
|
||||
|
# Declareer een variabele als een str |
||||
|
# en krijg editorondersteuning in de functie |
||||
|
def main(user_id: str): |
||||
|
return user_id |
||||
|
|
||||
|
|
||||
|
# Een Pydantic model |
||||
|
class User(BaseModel): |
||||
|
id: int |
||||
|
name: str |
||||
|
joined: date |
||||
|
``` |
||||
|
|
||||
|
Vervolgens kan je het op deze manier gebruiken: |
||||
|
|
||||
|
```Python |
||||
|
my_user: User = User(id=3, name="John Doe", joined="2018-07-19") |
||||
|
|
||||
|
second_user_data = { |
||||
|
"id": 4, |
||||
|
"name": "Mary", |
||||
|
"joined": "2018-11-30", |
||||
|
} |
||||
|
|
||||
|
my_second_user: User = User(**second_user_data) |
||||
|
``` |
||||
|
|
||||
|
/// info |
||||
|
|
||||
|
`**second_user_data` betekent: |
||||
|
|
||||
|
Geef de sleutels (keys) en waarden (values) van de `second_user_data` dict direct door als sleutel-waarden argumenten, gelijk aan: `User(id=4, name=“Mary”, joined=“2018-11-30”)` |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
### Editor-ondersteuning |
||||
|
|
||||
|
Het gehele framework is ontworpen om eenvoudig en intuïtief te zijn in gebruik. Alle beslissingen zijn getest op meerdere code-editors nog voordat het daadwerkelijke ontwikkelen begon, om zo de beste ontwikkelervaring te garanderen. |
||||
|
|
||||
|
Uit enquêtes onder Python ontwikkelaars blijkt maar al te duidelijk dat "(automatische) code aanvulling" <a href="https://www.jetbrains.com/research/python-developers-survey-2017/#tools-and-features" class="external-link" target="_blank">een van de meest gebruikte functionaliteiten is</a>. |
||||
|
|
||||
|
Het hele **FastAPI** framework is daarop gebaseerd. Automatische code aanvulling werkt overal. |
||||
|
|
||||
|
Je hoeft zelden terug te vallen op de documentatie. |
||||
|
|
||||
|
Zo kan je editor je helpen: |
||||
|
|
||||
|
* in <a href="https://code.visualstudio.com/" class="external-link" target="_blank">Visual Studio Code</a>: |
||||
|
|
||||
|
 |
||||
|
|
||||
|
* in <a href="https://www.jetbrains.com/pycharm/" class="external-link" target="_blank">PyCharm</a>: |
||||
|
|
||||
|
 |
||||
|
|
||||
|
Je krijgt autocomletion die je voorheen misschien zelfs voor onmogelijk had gehouden. Zoals bijvoorbeeld de `price` key in een JSON body (die genest had kunnen zijn) die afkomstig is van een request. |
||||
|
|
||||
|
Je hoeft niet langer de verkeerde keys in te typen, op en neer te gaan tussen de documentatie, of heen en weer te scrollen om te checken of je `username` of toch `user_name` had gebruikt. |
||||
|
|
||||
|
### Kort |
||||
|
|
||||
|
Dit framework heeft voor alles verstandige **standaardinstellingen**, met overal optionele configuraties. Alle parameters kunnen worden verfijnd zodat het past bij wat je nodig hebt, om zo de API te kunnen definiëren die jij nodig hebt. |
||||
|
|
||||
|
Maar standaard werkt alles **“gewoon”**. |
||||
|
|
||||
|
### Validatie |
||||
|
|
||||
|
* Validatie voor de meeste (of misschien wel alle?) Python **datatypes**, inclusief: |
||||
|
* JSON objecten (`dict`). |
||||
|
* JSON array (`list`) die itemtypes definiëren. |
||||
|
* String (`str`) velden, die min en max lengtes hebben. |
||||
|
* Getallen (`int`, `float`) met min en max waarden, enz. |
||||
|
|
||||
|
* Validatie voor meer exotische typen, zoals: |
||||
|
* URL. |
||||
|
* E-mail. |
||||
|
* UUID. |
||||
|
* ...en anderen. |
||||
|
|
||||
|
Alle validatie wordt uitgevoerd door het beproefde en robuuste **Pydantic**. |
||||
|
|
||||
|
### Beveiliging en authenticatie |
||||
|
|
||||
|
Beveiliging en authenticatie is geïntegreerd. Zonder compromissen te doen naar databases of datamodellen. |
||||
|
|
||||
|
Alle beveiligingsschema's gedefinieerd in OpenAPI, inclusief: |
||||
|
|
||||
|
* HTTP Basic. |
||||
|
* **OAuth2** (ook met **JWT tokens**). Bekijk de tutorial over [OAuth2 with JWT](tutorial/security/oauth2-jwt.md){.internal-link target=_blank}. |
||||
|
* API keys in: |
||||
|
* Headers. |
||||
|
* Query parameters. |
||||
|
* Cookies, enz. |
||||
|
|
||||
|
Plus alle beveiligingsfuncties van Starlette (inclusief **sessiecookies**). |
||||
|
|
||||
|
Gebouwd als een herbruikbare tool met componenten die makkelijk te integreren zijn in en met je systemen, datastores, relationele en NoSQL databases, enz. |
||||
|
|
||||
|
### Dependency Injection |
||||
|
|
||||
|
FastAPI bevat een uiterst eenvoudig, maar uiterst krachtig <abbr title='ook bekend als "componenten", "bronnen", "diensten", "aanbieders"'><strong>Dependency Injection</strong></abbr> systeem. |
||||
|
|
||||
|
* Zelfs dependencies kunnen dependencies hebben, waardoor een hiërarchie of **“graph” van dependencies** ontstaat. |
||||
|
* Allemaal **automatisch afgehandeld** door het framework. |
||||
|
* Alle dependencies kunnen data nodig hebben van request, de vereiste **padoperaties veranderen** en automatische documentatie verstrekken. |
||||
|
* **Automatische validatie** zelfs voor *padoperatie* parameters gedefinieerd in dependencies. |
||||
|
* Ondersteuning voor complexe gebruikersauthenticatiesystemen, **databaseverbindingen**, enz. |
||||
|
* **Geen compromisen** met databases, gebruikersinterfaces, enz. Maar eenvoudige integratie met ze allemaal. |
||||
|
|
||||
|
### Ongelimiteerde "plug-ins" |
||||
|
|
||||
|
Of anders gezegd, je hebt ze niet nodig, importeer en gebruik de code die je nodig hebt. |
||||
|
|
||||
|
Elke integratie is ontworpen om eenvoudig te gebruiken (met afhankelijkheden), zodat je een “plug-in" kunt maken in 2 regels code, met dezelfde structuur en syntax die wordt gebruikt voor je *padbewerkingen*. |
||||
|
|
||||
|
### Getest |
||||
|
|
||||
|
* 100% <abbr title="De hoeveelheid code die automatisch wordt getest">van de code is getest</abbr>. |
||||
|
* 100% <abbr title="Python type annotaties, hiermee kunnen je editor en externe tools je beter ondersteunen">type geannoteerde</abbr> codebase. |
||||
|
* Wordt gebruikt in productietoepassingen. |
||||
|
|
||||
|
## Starlette functies |
||||
|
|
||||
|
**FastAPI** is volledig verenigbaar met (en gebaseerd op) <a href="https://www.starlette.io/" class="external-link" target="_blank"><strong>Starlette</strong></a>. |
||||
|
|
||||
|
`FastAPI` is eigenlijk een subklasse van `Starlette`. Dus als je Starlette al kent of gebruikt, zal de meeste functionaliteit op dezelfde manier werken. |
||||
|
|
||||
|
Met **FastAPI** krijg je alle functies van **Starlette** (FastAPI is gewoon Starlette op steroïden): |
||||
|
|
||||
|
* Zeer indrukwekkende prestaties. Het is <a href="https://github.com/encode/starlette#performance" class="external-link" target="_blank">een van de snelste Python frameworks, vergelijkbaar met **NodeJS** en **Go**</a>. |
||||
|
* **WebSocket** ondersteuning. |
||||
|
* Taken in de achtergrond tijdens het proces. |
||||
|
* Opstart- en afsluit events. |
||||
|
* Test client gebouwd op HTTPX. |
||||
|
* **CORS**, GZip, Statische bestanden, Streaming reacties. |
||||
|
* **Sessie en Cookie** ondersteuning. |
||||
|
* 100% van de code is getest. |
||||
|
* 100% type geannoteerde codebase. |
||||
|
|
||||
|
## Pydantic functionaliteit |
||||
|
|
||||
|
**FastAPI** is volledig verenigbaar met (en gebaseerd op) Pydantic. Dus alle extra <a href="https://docs.pydantic.dev/" class="external-link" target="_blank"><strong>Pydantic</strong></a> code die je nog hebt werkt ook. |
||||
|
|
||||
|
Inclusief externe pakketten die ook gebaseerd zijn op Pydantic, zoals <abbr title="Object-Relational Mapper">ORM</abbr>s, <abbr title="Object-Document Mapper">ODM</abbr>s voor databases. |
||||
|
|
||||
|
Dit betekent ook dat je in veel gevallen het object dat je van een request krijgt **direct naar je database** kunt sturen, omdat alles automatisch wordt gevalideerd. |
||||
|
|
||||
|
Hetzelfde geldt ook andersom, in veel gevallen kun je dus het object dat je krijgt van de database **direct doorgeven aan de client**. |
||||
|
|
||||
|
Met **FastAPI** krijg je alle functionaliteit van **Pydantic** (omdat FastAPI is gebaseerd op Pydantic voor alle dataverwerking): |
||||
|
|
||||
|
* **Geen brainfucks**: |
||||
|
* Je hoeft geen nieuwe microtaal voor schemadefinities te leren. |
||||
|
* Als je bekend bent Python types, weet je hoe je Pydantic moet gebruiken. |
||||
|
* Werkt goed samen met je **<abbr title=“Integrated Development Environment, vergelijkbaar met een code editor”>IDE</abbr>/<abbr title=“Een programma dat controleert op fouten in de code”>linter</abbr>/hersenen**: |
||||
|
* Doordat pydantic's datastructuren enkel instanties zijn van klassen, die je definieert, werkt automatische aanvulling, linting, mypy en je intuïtie allemaal goed met je gevalideerde data. |
||||
|
* Valideer **complexe structuren**: |
||||
|
* Gebruik van hiërarchische Pydantic modellen, Python `typing`'s `List` en `Dict`, enz. |
||||
|
* Met validators kunnen complexe dataschema's duidelijk en eenvoudig worden gedefinieerd, gecontroleerd en gedocumenteerd als JSON Schema. |
||||
|
* Je kunt diep **geneste JSON** objecten laten valideren en annoteren. |
||||
|
* **Uitbreidbaar**: |
||||
|
* Met Pydantic kunnen op maat gemaakte datatypen worden gedefinieerd of je kunt validatie uitbreiden met methoden op een model dat is ingericht met de decorator validator. |
||||
|
* 100% van de code is getest. |
||||
@ -0,0 +1,19 @@ |
|||||
|
# Segurança Avançada |
||||
|
|
||||
|
## Funcionalidades Adicionais |
||||
|
|
||||
|
Existem algumas funcionalidades adicionais para lidar com segurança além das cobertas em [Tutorial - Guia de Usuário: Segurança](../../tutorial/security/index.md){.internal-link target=_blank}. |
||||
|
|
||||
|
/// tip | "Dica" |
||||
|
|
||||
|
As próximas seções **não são necessariamente "avançadas"**. |
||||
|
|
||||
|
E é possível que para o seu caso de uso, a solução está em uma delas. |
||||
|
|
||||
|
/// |
||||
|
|
||||
|
## Leia o Tutorial primeiro |
||||
|
|
||||
|
As próximas seções pressupõem que você já leu o principal [Tutorial - Guia de Usuário: Segurança](../../tutorial/security/index.md){.internal-link target=_blank}. |
||||
|
|
||||
|
Todas elas são baseadas nos mesmos conceitos, mas permitem algumas funcionalidades extras. |
||||
@ -0,0 +1,7 @@ |
|||||
|
# Testando Eventos: inicialização - encerramento |
||||
|
|
||||
|
Quando você precisa que os seus manipuladores de eventos (`startup` e `shutdown`) sejam executados em seus testes, você pode utilizar o `TestClient` usando a instrução `with`: |
||||
|
|
||||
|
```Python hl_lines="9-12 20-24" |
||||
|
{!../../../docs_src/app_testing/tutorial003.py!} |
||||
|
``` |
||||
@ -0,0 +1,14 @@ |
|||||
|
from fastapi import FastAPI, Form |
||||
|
from pydantic import BaseModel |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
class FormData(BaseModel): |
||||
|
username: str |
||||
|
password: str |
||||
|
|
||||
|
|
||||
|
@app.post("/login/") |
||||
|
async def login(data: FormData = Form()): |
||||
|
return data |
||||
@ -0,0 +1,15 @@ |
|||||
|
from fastapi import FastAPI, Form |
||||
|
from pydantic import BaseModel |
||||
|
from typing_extensions import Annotated |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
class FormData(BaseModel): |
||||
|
username: str |
||||
|
password: str |
||||
|
|
||||
|
|
||||
|
@app.post("/login/") |
||||
|
async def login(data: Annotated[FormData, Form()]): |
||||
|
return data |
||||
@ -0,0 +1,16 @@ |
|||||
|
from typing import Annotated |
||||
|
|
||||
|
from fastapi import FastAPI, Form |
||||
|
from pydantic import BaseModel |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
class FormData(BaseModel): |
||||
|
username: str |
||||
|
password: str |
||||
|
|
||||
|
|
||||
|
@app.post("/login/") |
||||
|
async def login(data: Annotated[FormData, Form()]): |
||||
|
return data |
||||
@ -0,0 +1,15 @@ |
|||||
|
from fastapi import FastAPI, Form |
||||
|
from pydantic import BaseModel |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
class FormData(BaseModel): |
||||
|
username: str |
||||
|
password: str |
||||
|
model_config = {"extra": "forbid"} |
||||
|
|
||||
|
|
||||
|
@app.post("/login/") |
||||
|
async def login(data: FormData = Form()): |
||||
|
return data |
||||
@ -0,0 +1,16 @@ |
|||||
|
from fastapi import FastAPI, Form |
||||
|
from pydantic import BaseModel |
||||
|
from typing_extensions import Annotated |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
class FormData(BaseModel): |
||||
|
username: str |
||||
|
password: str |
||||
|
model_config = {"extra": "forbid"} |
||||
|
|
||||
|
|
||||
|
@app.post("/login/") |
||||
|
async def login(data: Annotated[FormData, Form()]): |
||||
|
return data |
||||
@ -0,0 +1,17 @@ |
|||||
|
from typing import Annotated |
||||
|
|
||||
|
from fastapi import FastAPI, Form |
||||
|
from pydantic import BaseModel |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
class FormData(BaseModel): |
||||
|
username: str |
||||
|
password: str |
||||
|
model_config = {"extra": "forbid"} |
||||
|
|
||||
|
|
||||
|
@app.post("/login/") |
||||
|
async def login(data: Annotated[FormData, Form()]): |
||||
|
return data |
||||
@ -0,0 +1,17 @@ |
|||||
|
from fastapi import FastAPI, Form |
||||
|
from pydantic import BaseModel |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
class FormData(BaseModel): |
||||
|
username: str |
||||
|
password: str |
||||
|
|
||||
|
class Config: |
||||
|
extra = "forbid" |
||||
|
|
||||
|
|
||||
|
@app.post("/login/") |
||||
|
async def login(data: FormData = Form()): |
||||
|
return data |
||||
@ -0,0 +1,18 @@ |
|||||
|
from fastapi import FastAPI, Form |
||||
|
from pydantic import BaseModel |
||||
|
from typing_extensions import Annotated |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
class FormData(BaseModel): |
||||
|
username: str |
||||
|
password: str |
||||
|
|
||||
|
class Config: |
||||
|
extra = "forbid" |
||||
|
|
||||
|
|
||||
|
@app.post("/login/") |
||||
|
async def login(data: Annotated[FormData, Form()]): |
||||
|
return data |
||||
@ -0,0 +1,19 @@ |
|||||
|
from typing import Annotated |
||||
|
|
||||
|
from fastapi import FastAPI, Form |
||||
|
from pydantic import BaseModel |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
class FormData(BaseModel): |
||||
|
username: str |
||||
|
password: str |
||||
|
|
||||
|
class Config: |
||||
|
extra = "forbid" |
||||
|
|
||||
|
|
||||
|
@app.post("/login/") |
||||
|
async def login(data: Annotated[FormData, Form()]): |
||||
|
return data |
||||
@ -1,58 +1,37 @@ |
|||||
from typing import Any, Callable, List, Optional, Sequence |
from dataclasses import dataclass, field |
||||
|
from typing import Any, Callable, List, Optional, Sequence, Tuple |
||||
|
|
||||
from fastapi._compat import ModelField |
from fastapi._compat import ModelField |
||||
from fastapi.security.base import SecurityBase |
from fastapi.security.base import SecurityBase |
||||
|
|
||||
|
|
||||
|
@dataclass |
||||
class SecurityRequirement: |
class SecurityRequirement: |
||||
def __init__( |
security_scheme: SecurityBase |
||||
self, security_scheme: SecurityBase, scopes: Optional[Sequence[str]] = None |
scopes: Optional[Sequence[str]] = None |
||||
): |
|
||||
self.security_scheme = security_scheme |
|
||||
self.scopes = scopes |
|
||||
|
|
||||
|
|
||||
|
@dataclass |
||||
class Dependant: |
class Dependant: |
||||
def __init__( |
path_params: List[ModelField] = field(default_factory=list) |
||||
self, |
query_params: List[ModelField] = field(default_factory=list) |
||||
*, |
header_params: List[ModelField] = field(default_factory=list) |
||||
path_params: Optional[List[ModelField]] = None, |
cookie_params: List[ModelField] = field(default_factory=list) |
||||
query_params: Optional[List[ModelField]] = None, |
body_params: List[ModelField] = field(default_factory=list) |
||||
header_params: Optional[List[ModelField]] = None, |
dependencies: List["Dependant"] = field(default_factory=list) |
||||
cookie_params: Optional[List[ModelField]] = None, |
security_requirements: List[SecurityRequirement] = field(default_factory=list) |
||||
body_params: Optional[List[ModelField]] = None, |
name: Optional[str] = None |
||||
dependencies: Optional[List["Dependant"]] = None, |
call: Optional[Callable[..., Any]] = None |
||||
security_schemes: Optional[List[SecurityRequirement]] = None, |
request_param_name: Optional[str] = None |
||||
name: Optional[str] = None, |
websocket_param_name: Optional[str] = None |
||||
call: Optional[Callable[..., Any]] = None, |
http_connection_param_name: Optional[str] = None |
||||
request_param_name: Optional[str] = None, |
response_param_name: Optional[str] = None |
||||
websocket_param_name: Optional[str] = None, |
background_tasks_param_name: Optional[str] = None |
||||
http_connection_param_name: Optional[str] = None, |
security_scopes_param_name: Optional[str] = None |
||||
response_param_name: Optional[str] = None, |
security_scopes: Optional[List[str]] = None |
||||
background_tasks_param_name: Optional[str] = None, |
use_cache: bool = True |
||||
security_scopes_param_name: Optional[str] = None, |
path: Optional[str] = None |
||||
security_scopes: Optional[List[str]] = None, |
cache_key: Tuple[Optional[Callable[..., Any]], Tuple[str, ...]] = field(init=False) |
||||
use_cache: bool = True, |
|
||||
path: Optional[str] = None, |
def __post_init__(self) -> None: |
||||
) -> None: |
|
||||
self.path_params = path_params or [] |
|
||||
self.query_params = query_params or [] |
|
||||
self.header_params = header_params or [] |
|
||||
self.cookie_params = cookie_params or [] |
|
||||
self.body_params = body_params or [] |
|
||||
self.dependencies = dependencies or [] |
|
||||
self.security_requirements = security_schemes or [] |
|
||||
self.request_param_name = request_param_name |
|
||||
self.websocket_param_name = websocket_param_name |
|
||||
self.http_connection_param_name = http_connection_param_name |
|
||||
self.response_param_name = response_param_name |
|
||||
self.background_tasks_param_name = background_tasks_param_name |
|
||||
self.security_scopes = security_scopes |
|
||||
self.security_scopes_param_name = security_scopes_param_name |
|
||||
self.name = name |
|
||||
self.call = call |
|
||||
self.use_cache = use_cache |
|
||||
# Store the path to be able to re-generate a dependable from it in overrides |
|
||||
self.path = path |
|
||||
# Save the cache key at creation to optimize performance |
|
||||
self.cache_key = (self.call, tuple(sorted(set(self.security_scopes or [])))) |
self.cache_key = (self.call, tuple(sorted(set(self.security_scopes or [])))) |
||||
|
|||||
@ -0,0 +1,36 @@ |
|||||
|
import subprocess |
||||
|
import time |
||||
|
|
||||
|
import httpx |
||||
|
from playwright.sync_api import Playwright, sync_playwright |
||||
|
|
||||
|
|
||||
|
# Run playwright codegen to generate the code below, copy paste the sections in run() |
||||
|
def run(playwright: Playwright) -> None: |
||||
|
browser = playwright.chromium.launch(headless=False) |
||||
|
context = browser.new_context() |
||||
|
page = context.new_page() |
||||
|
page.goto("http://localhost:8000/docs") |
||||
|
page.get_by_role("button", name="POST /login/ Login").click() |
||||
|
page.get_by_role("button", name="Try it out").click() |
||||
|
page.screenshot(path="docs/en/docs/img/tutorial/request-form-models/image01.png") |
||||
|
|
||||
|
# --------------------- |
||||
|
context.close() |
||||
|
browser.close() |
||||
|
|
||||
|
|
||||
|
process = subprocess.Popen( |
||||
|
["fastapi", "run", "docs_src/request_form_models/tutorial001.py"] |
||||
|
) |
||||
|
try: |
||||
|
for _ in range(3): |
||||
|
try: |
||||
|
response = httpx.get("http://localhost:8000/docs") |
||||
|
except httpx.ConnectError: |
||||
|
time.sleep(1) |
||||
|
break |
||||
|
with sync_playwright() as playwright: |
||||
|
run(playwright) |
||||
|
finally: |
||||
|
process.terminate() |
||||
@ -0,0 +1,129 @@ |
|||||
|
from typing import List, Optional |
||||
|
|
||||
|
from dirty_equals import IsDict |
||||
|
from fastapi import FastAPI, Form |
||||
|
from fastapi.testclient import TestClient |
||||
|
from pydantic import BaseModel |
||||
|
from typing_extensions import Annotated |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
class FormModel(BaseModel): |
||||
|
username: str |
||||
|
lastname: str |
||||
|
age: Optional[int] = None |
||||
|
tags: List[str] = ["foo", "bar"] |
||||
|
|
||||
|
|
||||
|
@app.post("/form/") |
||||
|
def post_form(user: Annotated[FormModel, Form()]): |
||||
|
return user |
||||
|
|
||||
|
|
||||
|
client = TestClient(app) |
||||
|
|
||||
|
|
||||
|
def test_send_all_data(): |
||||
|
response = client.post( |
||||
|
"/form/", |
||||
|
data={ |
||||
|
"username": "Rick", |
||||
|
"lastname": "Sanchez", |
||||
|
"age": "70", |
||||
|
"tags": ["plumbus", "citadel"], |
||||
|
}, |
||||
|
) |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == { |
||||
|
"username": "Rick", |
||||
|
"lastname": "Sanchez", |
||||
|
"age": 70, |
||||
|
"tags": ["plumbus", "citadel"], |
||||
|
} |
||||
|
|
||||
|
|
||||
|
def test_defaults(): |
||||
|
response = client.post("/form/", data={"username": "Rick", "lastname": "Sanchez"}) |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == { |
||||
|
"username": "Rick", |
||||
|
"lastname": "Sanchez", |
||||
|
"age": None, |
||||
|
"tags": ["foo", "bar"], |
||||
|
} |
||||
|
|
||||
|
|
||||
|
def test_invalid_data(): |
||||
|
response = client.post( |
||||
|
"/form/", |
||||
|
data={ |
||||
|
"username": "Rick", |
||||
|
"lastname": "Sanchez", |
||||
|
"age": "seventy", |
||||
|
"tags": ["plumbus", "citadel"], |
||||
|
}, |
||||
|
) |
||||
|
assert response.status_code == 422, response.text |
||||
|
assert response.json() == IsDict( |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "int_parsing", |
||||
|
"loc": ["body", "age"], |
||||
|
"msg": "Input should be a valid integer, unable to parse string as an integer", |
||||
|
"input": "seventy", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
) | IsDict( |
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"loc": ["body", "age"], |
||||
|
"msg": "value is not a valid integer", |
||||
|
"type": "type_error.integer", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
) |
||||
|
|
||||
|
|
||||
|
def test_no_data(): |
||||
|
response = client.post("/form/") |
||||
|
assert response.status_code == 422, response.text |
||||
|
assert response.json() == IsDict( |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {"tags": ["foo", "bar"]}, |
||||
|
}, |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "lastname"], |
||||
|
"msg": "Field required", |
||||
|
"input": {"tags": ["foo", "bar"]}, |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
) | IsDict( |
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
{ |
||||
|
"loc": ["body", "lastname"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
) |
||||
@ -0,0 +1,99 @@ |
|||||
|
from fastapi import FastAPI, Form |
||||
|
from fastapi.testclient import TestClient |
||||
|
from typing_extensions import Annotated |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
@app.post("/form/") |
||||
|
def post_form(username: Annotated[str, Form()]): |
||||
|
return username |
||||
|
|
||||
|
|
||||
|
client = TestClient(app) |
||||
|
|
||||
|
|
||||
|
def test_single_form_field(): |
||||
|
response = client.post("/form/", data={"username": "Rick"}) |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == "Rick" |
||||
|
|
||||
|
|
||||
|
def test_openapi_schema(): |
||||
|
response = client.get("/openapi.json") |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == { |
||||
|
"openapi": "3.1.0", |
||||
|
"info": {"title": "FastAPI", "version": "0.1.0"}, |
||||
|
"paths": { |
||||
|
"/form/": { |
||||
|
"post": { |
||||
|
"summary": "Post Form", |
||||
|
"operationId": "post_form_form__post", |
||||
|
"requestBody": { |
||||
|
"content": { |
||||
|
"application/x-www-form-urlencoded": { |
||||
|
"schema": { |
||||
|
"$ref": "#/components/schemas/Body_post_form_form__post" |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
"required": True, |
||||
|
}, |
||||
|
"responses": { |
||||
|
"200": { |
||||
|
"description": "Successful Response", |
||||
|
"content": {"application/json": {"schema": {}}}, |
||||
|
}, |
||||
|
"422": { |
||||
|
"description": "Validation Error", |
||||
|
"content": { |
||||
|
"application/json": { |
||||
|
"schema": { |
||||
|
"$ref": "#/components/schemas/HTTPValidationError" |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
}, |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
"components": { |
||||
|
"schemas": { |
||||
|
"Body_post_form_form__post": { |
||||
|
"properties": {"username": {"type": "string", "title": "Username"}}, |
||||
|
"type": "object", |
||||
|
"required": ["username"], |
||||
|
"title": "Body_post_form_form__post", |
||||
|
}, |
||||
|
"HTTPValidationError": { |
||||
|
"properties": { |
||||
|
"detail": { |
||||
|
"items": {"$ref": "#/components/schemas/ValidationError"}, |
||||
|
"type": "array", |
||||
|
"title": "Detail", |
||||
|
} |
||||
|
}, |
||||
|
"type": "object", |
||||
|
"title": "HTTPValidationError", |
||||
|
}, |
||||
|
"ValidationError": { |
||||
|
"properties": { |
||||
|
"loc": { |
||||
|
"items": { |
||||
|
"anyOf": [{"type": "string"}, {"type": "integer"}] |
||||
|
}, |
||||
|
"type": "array", |
||||
|
"title": "Location", |
||||
|
}, |
||||
|
"msg": {"type": "string", "title": "Message"}, |
||||
|
"type": {"type": "string", "title": "Error Type"}, |
||||
|
}, |
||||
|
"type": "object", |
||||
|
"required": ["loc", "msg", "type"], |
||||
|
"title": "ValidationError", |
||||
|
}, |
||||
|
} |
||||
|
}, |
||||
|
} |
||||
@ -0,0 +1,232 @@ |
|||||
|
import pytest |
||||
|
from dirty_equals import IsDict |
||||
|
from fastapi.testclient import TestClient |
||||
|
|
||||
|
|
||||
|
@pytest.fixture(name="client") |
||||
|
def get_client(): |
||||
|
from docs_src.request_form_models.tutorial001 import app |
||||
|
|
||||
|
client = TestClient(app) |
||||
|
return client |
||||
|
|
||||
|
|
||||
|
def test_post_body_form(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 200 |
||||
|
assert response.json() == {"username": "Foo", "password": "secret"} |
||||
|
|
||||
|
|
||||
|
def test_post_body_form_no_password(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == IsDict( |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {"username": "Foo"}, |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
) | IsDict( |
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
) |
||||
|
|
||||
|
|
||||
|
def test_post_body_form_no_username(client: TestClient): |
||||
|
response = client.post("/login/", data={"password": "secret"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == IsDict( |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {"password": "secret"}, |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
) | IsDict( |
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
) |
||||
|
|
||||
|
|
||||
|
def test_post_body_form_no_data(client: TestClient): |
||||
|
response = client.post("/login/") |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == IsDict( |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
) | IsDict( |
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
{ |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
) |
||||
|
|
||||
|
|
||||
|
def test_post_body_json(client: TestClient): |
||||
|
response = client.post("/login/", json={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 422, response.text |
||||
|
assert response.json() == IsDict( |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
) | IsDict( |
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
{ |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
) |
||||
|
|
||||
|
|
||||
|
def test_openapi_schema(client: TestClient): |
||||
|
response = client.get("/openapi.json") |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == { |
||||
|
"openapi": "3.1.0", |
||||
|
"info": {"title": "FastAPI", "version": "0.1.0"}, |
||||
|
"paths": { |
||||
|
"/login/": { |
||||
|
"post": { |
||||
|
"responses": { |
||||
|
"200": { |
||||
|
"description": "Successful Response", |
||||
|
"content": {"application/json": {"schema": {}}}, |
||||
|
}, |
||||
|
"422": { |
||||
|
"description": "Validation Error", |
||||
|
"content": { |
||||
|
"application/json": { |
||||
|
"schema": { |
||||
|
"$ref": "#/components/schemas/HTTPValidationError" |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
}, |
||||
|
"summary": "Login", |
||||
|
"operationId": "login_login__post", |
||||
|
"requestBody": { |
||||
|
"content": { |
||||
|
"application/x-www-form-urlencoded": { |
||||
|
"schema": {"$ref": "#/components/schemas/FormData"} |
||||
|
} |
||||
|
}, |
||||
|
"required": True, |
||||
|
}, |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
"components": { |
||||
|
"schemas": { |
||||
|
"FormData": { |
||||
|
"properties": { |
||||
|
"username": {"type": "string", "title": "Username"}, |
||||
|
"password": {"type": "string", "title": "Password"}, |
||||
|
}, |
||||
|
"type": "object", |
||||
|
"required": ["username", "password"], |
||||
|
"title": "FormData", |
||||
|
}, |
||||
|
"ValidationError": { |
||||
|
"title": "ValidationError", |
||||
|
"required": ["loc", "msg", "type"], |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"loc": { |
||||
|
"title": "Location", |
||||
|
"type": "array", |
||||
|
"items": { |
||||
|
"anyOf": [{"type": "string"}, {"type": "integer"}] |
||||
|
}, |
||||
|
}, |
||||
|
"msg": {"title": "Message", "type": "string"}, |
||||
|
"type": {"title": "Error Type", "type": "string"}, |
||||
|
}, |
||||
|
}, |
||||
|
"HTTPValidationError": { |
||||
|
"title": "HTTPValidationError", |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"detail": { |
||||
|
"title": "Detail", |
||||
|
"type": "array", |
||||
|
"items": {"$ref": "#/components/schemas/ValidationError"}, |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
} |
||||
|
}, |
||||
|
} |
||||
@ -0,0 +1,232 @@ |
|||||
|
import pytest |
||||
|
from dirty_equals import IsDict |
||||
|
from fastapi.testclient import TestClient |
||||
|
|
||||
|
|
||||
|
@pytest.fixture(name="client") |
||||
|
def get_client(): |
||||
|
from docs_src.request_form_models.tutorial001_an import app |
||||
|
|
||||
|
client = TestClient(app) |
||||
|
return client |
||||
|
|
||||
|
|
||||
|
def test_post_body_form(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 200 |
||||
|
assert response.json() == {"username": "Foo", "password": "secret"} |
||||
|
|
||||
|
|
||||
|
def test_post_body_form_no_password(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == IsDict( |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {"username": "Foo"}, |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
) | IsDict( |
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
) |
||||
|
|
||||
|
|
||||
|
def test_post_body_form_no_username(client: TestClient): |
||||
|
response = client.post("/login/", data={"password": "secret"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == IsDict( |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {"password": "secret"}, |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
) | IsDict( |
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
) |
||||
|
|
||||
|
|
||||
|
def test_post_body_form_no_data(client: TestClient): |
||||
|
response = client.post("/login/") |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == IsDict( |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
) | IsDict( |
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
{ |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
) |
||||
|
|
||||
|
|
||||
|
def test_post_body_json(client: TestClient): |
||||
|
response = client.post("/login/", json={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 422, response.text |
||||
|
assert response.json() == IsDict( |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
) | IsDict( |
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
{ |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
) |
||||
|
|
||||
|
|
||||
|
def test_openapi_schema(client: TestClient): |
||||
|
response = client.get("/openapi.json") |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == { |
||||
|
"openapi": "3.1.0", |
||||
|
"info": {"title": "FastAPI", "version": "0.1.0"}, |
||||
|
"paths": { |
||||
|
"/login/": { |
||||
|
"post": { |
||||
|
"responses": { |
||||
|
"200": { |
||||
|
"description": "Successful Response", |
||||
|
"content": {"application/json": {"schema": {}}}, |
||||
|
}, |
||||
|
"422": { |
||||
|
"description": "Validation Error", |
||||
|
"content": { |
||||
|
"application/json": { |
||||
|
"schema": { |
||||
|
"$ref": "#/components/schemas/HTTPValidationError" |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
}, |
||||
|
"summary": "Login", |
||||
|
"operationId": "login_login__post", |
||||
|
"requestBody": { |
||||
|
"content": { |
||||
|
"application/x-www-form-urlencoded": { |
||||
|
"schema": {"$ref": "#/components/schemas/FormData"} |
||||
|
} |
||||
|
}, |
||||
|
"required": True, |
||||
|
}, |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
"components": { |
||||
|
"schemas": { |
||||
|
"FormData": { |
||||
|
"properties": { |
||||
|
"username": {"type": "string", "title": "Username"}, |
||||
|
"password": {"type": "string", "title": "Password"}, |
||||
|
}, |
||||
|
"type": "object", |
||||
|
"required": ["username", "password"], |
||||
|
"title": "FormData", |
||||
|
}, |
||||
|
"ValidationError": { |
||||
|
"title": "ValidationError", |
||||
|
"required": ["loc", "msg", "type"], |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"loc": { |
||||
|
"title": "Location", |
||||
|
"type": "array", |
||||
|
"items": { |
||||
|
"anyOf": [{"type": "string"}, {"type": "integer"}] |
||||
|
}, |
||||
|
}, |
||||
|
"msg": {"title": "Message", "type": "string"}, |
||||
|
"type": {"title": "Error Type", "type": "string"}, |
||||
|
}, |
||||
|
}, |
||||
|
"HTTPValidationError": { |
||||
|
"title": "HTTPValidationError", |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"detail": { |
||||
|
"title": "Detail", |
||||
|
"type": "array", |
||||
|
"items": {"$ref": "#/components/schemas/ValidationError"}, |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
} |
||||
|
}, |
||||
|
} |
||||
@ -0,0 +1,240 @@ |
|||||
|
import pytest |
||||
|
from dirty_equals import IsDict |
||||
|
from fastapi.testclient import TestClient |
||||
|
|
||||
|
from tests.utils import needs_py39 |
||||
|
|
||||
|
|
||||
|
@pytest.fixture(name="client") |
||||
|
def get_client(): |
||||
|
from docs_src.request_form_models.tutorial001_an_py39 import app |
||||
|
|
||||
|
client = TestClient(app) |
||||
|
return client |
||||
|
|
||||
|
|
||||
|
@needs_py39 |
||||
|
def test_post_body_form(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 200 |
||||
|
assert response.json() == {"username": "Foo", "password": "secret"} |
||||
|
|
||||
|
|
||||
|
@needs_py39 |
||||
|
def test_post_body_form_no_password(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == IsDict( |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {"username": "Foo"}, |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
) | IsDict( |
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
) |
||||
|
|
||||
|
|
||||
|
@needs_py39 |
||||
|
def test_post_body_form_no_username(client: TestClient): |
||||
|
response = client.post("/login/", data={"password": "secret"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == IsDict( |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {"password": "secret"}, |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
) | IsDict( |
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
) |
||||
|
|
||||
|
|
||||
|
@needs_py39 |
||||
|
def test_post_body_form_no_data(client: TestClient): |
||||
|
response = client.post("/login/") |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == IsDict( |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
) | IsDict( |
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
{ |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
) |
||||
|
|
||||
|
|
||||
|
@needs_py39 |
||||
|
def test_post_body_json(client: TestClient): |
||||
|
response = client.post("/login/", json={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 422, response.text |
||||
|
assert response.json() == IsDict( |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
) | IsDict( |
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
{ |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
{ |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
) |
||||
|
|
||||
|
|
||||
|
@needs_py39 |
||||
|
def test_openapi_schema(client: TestClient): |
||||
|
response = client.get("/openapi.json") |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == { |
||||
|
"openapi": "3.1.0", |
||||
|
"info": {"title": "FastAPI", "version": "0.1.0"}, |
||||
|
"paths": { |
||||
|
"/login/": { |
||||
|
"post": { |
||||
|
"responses": { |
||||
|
"200": { |
||||
|
"description": "Successful Response", |
||||
|
"content": {"application/json": {"schema": {}}}, |
||||
|
}, |
||||
|
"422": { |
||||
|
"description": "Validation Error", |
||||
|
"content": { |
||||
|
"application/json": { |
||||
|
"schema": { |
||||
|
"$ref": "#/components/schemas/HTTPValidationError" |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
}, |
||||
|
"summary": "Login", |
||||
|
"operationId": "login_login__post", |
||||
|
"requestBody": { |
||||
|
"content": { |
||||
|
"application/x-www-form-urlencoded": { |
||||
|
"schema": {"$ref": "#/components/schemas/FormData"} |
||||
|
} |
||||
|
}, |
||||
|
"required": True, |
||||
|
}, |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
"components": { |
||||
|
"schemas": { |
||||
|
"FormData": { |
||||
|
"properties": { |
||||
|
"username": {"type": "string", "title": "Username"}, |
||||
|
"password": {"type": "string", "title": "Password"}, |
||||
|
}, |
||||
|
"type": "object", |
||||
|
"required": ["username", "password"], |
||||
|
"title": "FormData", |
||||
|
}, |
||||
|
"ValidationError": { |
||||
|
"title": "ValidationError", |
||||
|
"required": ["loc", "msg", "type"], |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"loc": { |
||||
|
"title": "Location", |
||||
|
"type": "array", |
||||
|
"items": { |
||||
|
"anyOf": [{"type": "string"}, {"type": "integer"}] |
||||
|
}, |
||||
|
}, |
||||
|
"msg": {"title": "Message", "type": "string"}, |
||||
|
"type": {"title": "Error Type", "type": "string"}, |
||||
|
}, |
||||
|
}, |
||||
|
"HTTPValidationError": { |
||||
|
"title": "HTTPValidationError", |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"detail": { |
||||
|
"title": "Detail", |
||||
|
"type": "array", |
||||
|
"items": {"$ref": "#/components/schemas/ValidationError"}, |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
} |
||||
|
}, |
||||
|
} |
||||
@ -0,0 +1,196 @@ |
|||||
|
import pytest |
||||
|
from fastapi.testclient import TestClient |
||||
|
|
||||
|
from tests.utils import needs_pydanticv2 |
||||
|
|
||||
|
|
||||
|
@pytest.fixture(name="client") |
||||
|
def get_client(): |
||||
|
from docs_src.request_form_models.tutorial002 import app |
||||
|
|
||||
|
client = TestClient(app) |
||||
|
return client |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_post_body_form(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 200 |
||||
|
assert response.json() == {"username": "Foo", "password": "secret"} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_post_body_extra_form(client: TestClient): |
||||
|
response = client.post( |
||||
|
"/login/", data={"username": "Foo", "password": "secret", "extra": "extra"} |
||||
|
) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "extra_forbidden", |
||||
|
"loc": ["body", "extra"], |
||||
|
"msg": "Extra inputs are not permitted", |
||||
|
"input": "extra", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_post_body_form_no_password(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {"username": "Foo"}, |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_post_body_form_no_username(client: TestClient): |
||||
|
response = client.post("/login/", data={"password": "secret"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {"password": "secret"}, |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_post_body_form_no_data(client: TestClient): |
||||
|
response = client.post("/login/") |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_post_body_json(client: TestClient): |
||||
|
response = client.post("/login/", json={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 422, response.text |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_openapi_schema(client: TestClient): |
||||
|
response = client.get("/openapi.json") |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == { |
||||
|
"openapi": "3.1.0", |
||||
|
"info": {"title": "FastAPI", "version": "0.1.0"}, |
||||
|
"paths": { |
||||
|
"/login/": { |
||||
|
"post": { |
||||
|
"responses": { |
||||
|
"200": { |
||||
|
"description": "Successful Response", |
||||
|
"content": {"application/json": {"schema": {}}}, |
||||
|
}, |
||||
|
"422": { |
||||
|
"description": "Validation Error", |
||||
|
"content": { |
||||
|
"application/json": { |
||||
|
"schema": { |
||||
|
"$ref": "#/components/schemas/HTTPValidationError" |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
}, |
||||
|
"summary": "Login", |
||||
|
"operationId": "login_login__post", |
||||
|
"requestBody": { |
||||
|
"content": { |
||||
|
"application/x-www-form-urlencoded": { |
||||
|
"schema": {"$ref": "#/components/schemas/FormData"} |
||||
|
} |
||||
|
}, |
||||
|
"required": True, |
||||
|
}, |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
"components": { |
||||
|
"schemas": { |
||||
|
"FormData": { |
||||
|
"properties": { |
||||
|
"username": {"type": "string", "title": "Username"}, |
||||
|
"password": {"type": "string", "title": "Password"}, |
||||
|
}, |
||||
|
"additionalProperties": False, |
||||
|
"type": "object", |
||||
|
"required": ["username", "password"], |
||||
|
"title": "FormData", |
||||
|
}, |
||||
|
"ValidationError": { |
||||
|
"title": "ValidationError", |
||||
|
"required": ["loc", "msg", "type"], |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"loc": { |
||||
|
"title": "Location", |
||||
|
"type": "array", |
||||
|
"items": { |
||||
|
"anyOf": [{"type": "string"}, {"type": "integer"}] |
||||
|
}, |
||||
|
}, |
||||
|
"msg": {"title": "Message", "type": "string"}, |
||||
|
"type": {"title": "Error Type", "type": "string"}, |
||||
|
}, |
||||
|
}, |
||||
|
"HTTPValidationError": { |
||||
|
"title": "HTTPValidationError", |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"detail": { |
||||
|
"title": "Detail", |
||||
|
"type": "array", |
||||
|
"items": {"$ref": "#/components/schemas/ValidationError"}, |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
} |
||||
|
}, |
||||
|
} |
||||
@ -0,0 +1,196 @@ |
|||||
|
import pytest |
||||
|
from fastapi.testclient import TestClient |
||||
|
|
||||
|
from tests.utils import needs_pydanticv2 |
||||
|
|
||||
|
|
||||
|
@pytest.fixture(name="client") |
||||
|
def get_client(): |
||||
|
from docs_src.request_form_models.tutorial002_an import app |
||||
|
|
||||
|
client = TestClient(app) |
||||
|
return client |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_post_body_form(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 200 |
||||
|
assert response.json() == {"username": "Foo", "password": "secret"} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_post_body_extra_form(client: TestClient): |
||||
|
response = client.post( |
||||
|
"/login/", data={"username": "Foo", "password": "secret", "extra": "extra"} |
||||
|
) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "extra_forbidden", |
||||
|
"loc": ["body", "extra"], |
||||
|
"msg": "Extra inputs are not permitted", |
||||
|
"input": "extra", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_post_body_form_no_password(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {"username": "Foo"}, |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_post_body_form_no_username(client: TestClient): |
||||
|
response = client.post("/login/", data={"password": "secret"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {"password": "secret"}, |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_post_body_form_no_data(client: TestClient): |
||||
|
response = client.post("/login/") |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_post_body_json(client: TestClient): |
||||
|
response = client.post("/login/", json={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 422, response.text |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
def test_openapi_schema(client: TestClient): |
||||
|
response = client.get("/openapi.json") |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == { |
||||
|
"openapi": "3.1.0", |
||||
|
"info": {"title": "FastAPI", "version": "0.1.0"}, |
||||
|
"paths": { |
||||
|
"/login/": { |
||||
|
"post": { |
||||
|
"responses": { |
||||
|
"200": { |
||||
|
"description": "Successful Response", |
||||
|
"content": {"application/json": {"schema": {}}}, |
||||
|
}, |
||||
|
"422": { |
||||
|
"description": "Validation Error", |
||||
|
"content": { |
||||
|
"application/json": { |
||||
|
"schema": { |
||||
|
"$ref": "#/components/schemas/HTTPValidationError" |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
}, |
||||
|
"summary": "Login", |
||||
|
"operationId": "login_login__post", |
||||
|
"requestBody": { |
||||
|
"content": { |
||||
|
"application/x-www-form-urlencoded": { |
||||
|
"schema": {"$ref": "#/components/schemas/FormData"} |
||||
|
} |
||||
|
}, |
||||
|
"required": True, |
||||
|
}, |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
"components": { |
||||
|
"schemas": { |
||||
|
"FormData": { |
||||
|
"properties": { |
||||
|
"username": {"type": "string", "title": "Username"}, |
||||
|
"password": {"type": "string", "title": "Password"}, |
||||
|
}, |
||||
|
"additionalProperties": False, |
||||
|
"type": "object", |
||||
|
"required": ["username", "password"], |
||||
|
"title": "FormData", |
||||
|
}, |
||||
|
"ValidationError": { |
||||
|
"title": "ValidationError", |
||||
|
"required": ["loc", "msg", "type"], |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"loc": { |
||||
|
"title": "Location", |
||||
|
"type": "array", |
||||
|
"items": { |
||||
|
"anyOf": [{"type": "string"}, {"type": "integer"}] |
||||
|
}, |
||||
|
}, |
||||
|
"msg": {"title": "Message", "type": "string"}, |
||||
|
"type": {"title": "Error Type", "type": "string"}, |
||||
|
}, |
||||
|
}, |
||||
|
"HTTPValidationError": { |
||||
|
"title": "HTTPValidationError", |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"detail": { |
||||
|
"title": "Detail", |
||||
|
"type": "array", |
||||
|
"items": {"$ref": "#/components/schemas/ValidationError"}, |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
} |
||||
|
}, |
||||
|
} |
||||
@ -0,0 +1,203 @@ |
|||||
|
import pytest |
||||
|
from fastapi.testclient import TestClient |
||||
|
|
||||
|
from tests.utils import needs_py39, needs_pydanticv2 |
||||
|
|
||||
|
|
||||
|
@pytest.fixture(name="client") |
||||
|
def get_client(): |
||||
|
from docs_src.request_form_models.tutorial002_an_py39 import app |
||||
|
|
||||
|
client = TestClient(app) |
||||
|
return client |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
@needs_py39 |
||||
|
def test_post_body_form(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 200 |
||||
|
assert response.json() == {"username": "Foo", "password": "secret"} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
@needs_py39 |
||||
|
def test_post_body_extra_form(client: TestClient): |
||||
|
response = client.post( |
||||
|
"/login/", data={"username": "Foo", "password": "secret", "extra": "extra"} |
||||
|
) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "extra_forbidden", |
||||
|
"loc": ["body", "extra"], |
||||
|
"msg": "Extra inputs are not permitted", |
||||
|
"input": "extra", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
@needs_py39 |
||||
|
def test_post_body_form_no_password(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {"username": "Foo"}, |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
@needs_py39 |
||||
|
def test_post_body_form_no_username(client: TestClient): |
||||
|
response = client.post("/login/", data={"password": "secret"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {"password": "secret"}, |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
@needs_py39 |
||||
|
def test_post_body_form_no_data(client: TestClient): |
||||
|
response = client.post("/login/") |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
@needs_py39 |
||||
|
def test_post_body_json(client: TestClient): |
||||
|
response = client.post("/login/", json={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 422, response.text |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
{ |
||||
|
"type": "missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "Field required", |
||||
|
"input": {}, |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv2 |
||||
|
@needs_py39 |
||||
|
def test_openapi_schema(client: TestClient): |
||||
|
response = client.get("/openapi.json") |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == { |
||||
|
"openapi": "3.1.0", |
||||
|
"info": {"title": "FastAPI", "version": "0.1.0"}, |
||||
|
"paths": { |
||||
|
"/login/": { |
||||
|
"post": { |
||||
|
"responses": { |
||||
|
"200": { |
||||
|
"description": "Successful Response", |
||||
|
"content": {"application/json": {"schema": {}}}, |
||||
|
}, |
||||
|
"422": { |
||||
|
"description": "Validation Error", |
||||
|
"content": { |
||||
|
"application/json": { |
||||
|
"schema": { |
||||
|
"$ref": "#/components/schemas/HTTPValidationError" |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
}, |
||||
|
"summary": "Login", |
||||
|
"operationId": "login_login__post", |
||||
|
"requestBody": { |
||||
|
"content": { |
||||
|
"application/x-www-form-urlencoded": { |
||||
|
"schema": {"$ref": "#/components/schemas/FormData"} |
||||
|
} |
||||
|
}, |
||||
|
"required": True, |
||||
|
}, |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
"components": { |
||||
|
"schemas": { |
||||
|
"FormData": { |
||||
|
"properties": { |
||||
|
"username": {"type": "string", "title": "Username"}, |
||||
|
"password": {"type": "string", "title": "Password"}, |
||||
|
}, |
||||
|
"additionalProperties": False, |
||||
|
"type": "object", |
||||
|
"required": ["username", "password"], |
||||
|
"title": "FormData", |
||||
|
}, |
||||
|
"ValidationError": { |
||||
|
"title": "ValidationError", |
||||
|
"required": ["loc", "msg", "type"], |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"loc": { |
||||
|
"title": "Location", |
||||
|
"type": "array", |
||||
|
"items": { |
||||
|
"anyOf": [{"type": "string"}, {"type": "integer"}] |
||||
|
}, |
||||
|
}, |
||||
|
"msg": {"title": "Message", "type": "string"}, |
||||
|
"type": {"title": "Error Type", "type": "string"}, |
||||
|
}, |
||||
|
}, |
||||
|
"HTTPValidationError": { |
||||
|
"title": "HTTPValidationError", |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"detail": { |
||||
|
"title": "Detail", |
||||
|
"type": "array", |
||||
|
"items": {"$ref": "#/components/schemas/ValidationError"}, |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
} |
||||
|
}, |
||||
|
} |
||||
@ -0,0 +1,189 @@ |
|||||
|
import pytest |
||||
|
from fastapi.testclient import TestClient |
||||
|
|
||||
|
from tests.utils import needs_pydanticv1 |
||||
|
|
||||
|
|
||||
|
@pytest.fixture(name="client") |
||||
|
def get_client(): |
||||
|
from docs_src.request_form_models.tutorial002_pv1 import app |
||||
|
|
||||
|
client = TestClient(app) |
||||
|
return client |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv1 |
||||
|
def test_post_body_form(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 200 |
||||
|
assert response.json() == {"username": "Foo", "password": "secret"} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv1 |
||||
|
def test_post_body_extra_form(client: TestClient): |
||||
|
response = client.post( |
||||
|
"/login/", data={"username": "Foo", "password": "secret", "extra": "extra"} |
||||
|
) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "value_error.extra", |
||||
|
"loc": ["body", "extra"], |
||||
|
"msg": "extra fields not permitted", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv1 |
||||
|
def test_post_body_form_no_password(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv1 |
||||
|
def test_post_body_form_no_username(client: TestClient): |
||||
|
response = client.post("/login/", data={"password": "secret"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv1 |
||||
|
def test_post_body_form_no_data(client: TestClient): |
||||
|
response = client.post("/login/") |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
}, |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv1 |
||||
|
def test_post_body_json(client: TestClient): |
||||
|
response = client.post("/login/", json={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 422, response.text |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
}, |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@needs_pydanticv1 |
||||
|
def test_openapi_schema(client: TestClient): |
||||
|
response = client.get("/openapi.json") |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == { |
||||
|
"openapi": "3.1.0", |
||||
|
"info": {"title": "FastAPI", "version": "0.1.0"}, |
||||
|
"paths": { |
||||
|
"/login/": { |
||||
|
"post": { |
||||
|
"responses": { |
||||
|
"200": { |
||||
|
"description": "Successful Response", |
||||
|
"content": {"application/json": {"schema": {}}}, |
||||
|
}, |
||||
|
"422": { |
||||
|
"description": "Validation Error", |
||||
|
"content": { |
||||
|
"application/json": { |
||||
|
"schema": { |
||||
|
"$ref": "#/components/schemas/HTTPValidationError" |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
}, |
||||
|
"summary": "Login", |
||||
|
"operationId": "login_login__post", |
||||
|
"requestBody": { |
||||
|
"content": { |
||||
|
"application/x-www-form-urlencoded": { |
||||
|
"schema": {"$ref": "#/components/schemas/FormData"} |
||||
|
} |
||||
|
}, |
||||
|
"required": True, |
||||
|
}, |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
"components": { |
||||
|
"schemas": { |
||||
|
"FormData": { |
||||
|
"properties": { |
||||
|
"username": {"type": "string", "title": "Username"}, |
||||
|
"password": {"type": "string", "title": "Password"}, |
||||
|
}, |
||||
|
"additionalProperties": False, |
||||
|
"type": "object", |
||||
|
"required": ["username", "password"], |
||||
|
"title": "FormData", |
||||
|
}, |
||||
|
"ValidationError": { |
||||
|
"title": "ValidationError", |
||||
|
"required": ["loc", "msg", "type"], |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"loc": { |
||||
|
"title": "Location", |
||||
|
"type": "array", |
||||
|
"items": { |
||||
|
"anyOf": [{"type": "string"}, {"type": "integer"}] |
||||
|
}, |
||||
|
}, |
||||
|
"msg": {"title": "Message", "type": "string"}, |
||||
|
"type": {"title": "Error Type", "type": "string"}, |
||||
|
}, |
||||
|
}, |
||||
|
"HTTPValidationError": { |
||||
|
"title": "HTTPValidationError", |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"detail": { |
||||
|
"title": "Detail", |
||||
|
"type": "array", |
||||
|
"items": {"$ref": "#/components/schemas/ValidationError"}, |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
} |
||||
|
}, |
||||
|
} |
||||
@ -0,0 +1,196 @@ |
|||||
|
import pytest |
||||
|
from fastapi.testclient import TestClient |
||||
|
|
||||
|
from tests.utils import needs_pydanticv1 |
||||
|
|
||||
|
|
||||
|
@pytest.fixture(name="client") |
||||
|
def get_client(): |
||||
|
from docs_src.request_form_models.tutorial002_pv1_an import app |
||||
|
|
||||
|
client = TestClient(app) |
||||
|
return client |
||||
|
|
||||
|
|
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
@needs_pydanticv1 |
||||
|
def test_post_body_form(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 200 |
||||
|
assert response.json() == {"username": "Foo", "password": "secret"} |
||||
|
|
||||
|
|
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
@needs_pydanticv1 |
||||
|
def test_post_body_extra_form(client: TestClient): |
||||
|
response = client.post( |
||||
|
"/login/", data={"username": "Foo", "password": "secret", "extra": "extra"} |
||||
|
) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "value_error.extra", |
||||
|
"loc": ["body", "extra"], |
||||
|
"msg": "extra fields not permitted", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
@needs_pydanticv1 |
||||
|
def test_post_body_form_no_password(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
@needs_pydanticv1 |
||||
|
def test_post_body_form_no_username(client: TestClient): |
||||
|
response = client.post("/login/", data={"password": "secret"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
@needs_pydanticv1 |
||||
|
def test_post_body_form_no_data(client: TestClient): |
||||
|
response = client.post("/login/") |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
}, |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
@needs_pydanticv1 |
||||
|
def test_post_body_json(client: TestClient): |
||||
|
response = client.post("/login/", json={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 422, response.text |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
}, |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
@needs_pydanticv1 |
||||
|
def test_openapi_schema(client: TestClient): |
||||
|
response = client.get("/openapi.json") |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == { |
||||
|
"openapi": "3.1.0", |
||||
|
"info": {"title": "FastAPI", "version": "0.1.0"}, |
||||
|
"paths": { |
||||
|
"/login/": { |
||||
|
"post": { |
||||
|
"responses": { |
||||
|
"200": { |
||||
|
"description": "Successful Response", |
||||
|
"content": {"application/json": {"schema": {}}}, |
||||
|
}, |
||||
|
"422": { |
||||
|
"description": "Validation Error", |
||||
|
"content": { |
||||
|
"application/json": { |
||||
|
"schema": { |
||||
|
"$ref": "#/components/schemas/HTTPValidationError" |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
}, |
||||
|
"summary": "Login", |
||||
|
"operationId": "login_login__post", |
||||
|
"requestBody": { |
||||
|
"content": { |
||||
|
"application/x-www-form-urlencoded": { |
||||
|
"schema": {"$ref": "#/components/schemas/FormData"} |
||||
|
} |
||||
|
}, |
||||
|
"required": True, |
||||
|
}, |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
"components": { |
||||
|
"schemas": { |
||||
|
"FormData": { |
||||
|
"properties": { |
||||
|
"username": {"type": "string", "title": "Username"}, |
||||
|
"password": {"type": "string", "title": "Password"}, |
||||
|
}, |
||||
|
"additionalProperties": False, |
||||
|
"type": "object", |
||||
|
"required": ["username", "password"], |
||||
|
"title": "FormData", |
||||
|
}, |
||||
|
"ValidationError": { |
||||
|
"title": "ValidationError", |
||||
|
"required": ["loc", "msg", "type"], |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"loc": { |
||||
|
"title": "Location", |
||||
|
"type": "array", |
||||
|
"items": { |
||||
|
"anyOf": [{"type": "string"}, {"type": "integer"}] |
||||
|
}, |
||||
|
}, |
||||
|
"msg": {"title": "Message", "type": "string"}, |
||||
|
"type": {"title": "Error Type", "type": "string"}, |
||||
|
}, |
||||
|
}, |
||||
|
"HTTPValidationError": { |
||||
|
"title": "HTTPValidationError", |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"detail": { |
||||
|
"title": "Detail", |
||||
|
"type": "array", |
||||
|
"items": {"$ref": "#/components/schemas/ValidationError"}, |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
} |
||||
|
}, |
||||
|
} |
||||
@ -0,0 +1,203 @@ |
|||||
|
import pytest |
||||
|
from fastapi.testclient import TestClient |
||||
|
|
||||
|
from tests.utils import needs_py39, needs_pydanticv1 |
||||
|
|
||||
|
|
||||
|
@pytest.fixture(name="client") |
||||
|
def get_client(): |
||||
|
from docs_src.request_form_models.tutorial002_pv1_an_py39 import app |
||||
|
|
||||
|
client = TestClient(app) |
||||
|
return client |
||||
|
|
||||
|
|
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
@needs_pydanticv1 |
||||
|
@needs_py39 |
||||
|
def test_post_body_form(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 200 |
||||
|
assert response.json() == {"username": "Foo", "password": "secret"} |
||||
|
|
||||
|
|
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
@needs_pydanticv1 |
||||
|
@needs_py39 |
||||
|
def test_post_body_extra_form(client: TestClient): |
||||
|
response = client.post( |
||||
|
"/login/", data={"username": "Foo", "password": "secret", "extra": "extra"} |
||||
|
) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "value_error.extra", |
||||
|
"loc": ["body", "extra"], |
||||
|
"msg": "extra fields not permitted", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
@needs_pydanticv1 |
||||
|
@needs_py39 |
||||
|
def test_post_body_form_no_password(client: TestClient): |
||||
|
response = client.post("/login/", data={"username": "Foo"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
@needs_pydanticv1 |
||||
|
@needs_py39 |
||||
|
def test_post_body_form_no_username(client: TestClient): |
||||
|
response = client.post("/login/", data={"password": "secret"}) |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
} |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
@needs_pydanticv1 |
||||
|
@needs_py39 |
||||
|
def test_post_body_form_no_data(client: TestClient): |
||||
|
response = client.post("/login/") |
||||
|
assert response.status_code == 422 |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
}, |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
@needs_pydanticv1 |
||||
|
@needs_py39 |
||||
|
def test_post_body_json(client: TestClient): |
||||
|
response = client.post("/login/", json={"username": "Foo", "password": "secret"}) |
||||
|
assert response.status_code == 422, response.text |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "username"], |
||||
|
"msg": "field required", |
||||
|
}, |
||||
|
{ |
||||
|
"type": "value_error.missing", |
||||
|
"loc": ["body", "password"], |
||||
|
"msg": "field required", |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
# TODO: remove when deprecating Pydantic v1 |
||||
|
@needs_pydanticv1 |
||||
|
@needs_py39 |
||||
|
def test_openapi_schema(client: TestClient): |
||||
|
response = client.get("/openapi.json") |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == { |
||||
|
"openapi": "3.1.0", |
||||
|
"info": {"title": "FastAPI", "version": "0.1.0"}, |
||||
|
"paths": { |
||||
|
"/login/": { |
||||
|
"post": { |
||||
|
"responses": { |
||||
|
"200": { |
||||
|
"description": "Successful Response", |
||||
|
"content": {"application/json": {"schema": {}}}, |
||||
|
}, |
||||
|
"422": { |
||||
|
"description": "Validation Error", |
||||
|
"content": { |
||||
|
"application/json": { |
||||
|
"schema": { |
||||
|
"$ref": "#/components/schemas/HTTPValidationError" |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
}, |
||||
|
"summary": "Login", |
||||
|
"operationId": "login_login__post", |
||||
|
"requestBody": { |
||||
|
"content": { |
||||
|
"application/x-www-form-urlencoded": { |
||||
|
"schema": {"$ref": "#/components/schemas/FormData"} |
||||
|
} |
||||
|
}, |
||||
|
"required": True, |
||||
|
}, |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
"components": { |
||||
|
"schemas": { |
||||
|
"FormData": { |
||||
|
"properties": { |
||||
|
"username": {"type": "string", "title": "Username"}, |
||||
|
"password": {"type": "string", "title": "Password"}, |
||||
|
}, |
||||
|
"additionalProperties": False, |
||||
|
"type": "object", |
||||
|
"required": ["username", "password"], |
||||
|
"title": "FormData", |
||||
|
}, |
||||
|
"ValidationError": { |
||||
|
"title": "ValidationError", |
||||
|
"required": ["loc", "msg", "type"], |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"loc": { |
||||
|
"title": "Location", |
||||
|
"type": "array", |
||||
|
"items": { |
||||
|
"anyOf": [{"type": "string"}, {"type": "integer"}] |
||||
|
}, |
||||
|
}, |
||||
|
"msg": {"title": "Message", "type": "string"}, |
||||
|
"type": {"title": "Error Type", "type": "string"}, |
||||
|
}, |
||||
|
}, |
||||
|
"HTTPValidationError": { |
||||
|
"title": "HTTPValidationError", |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"detail": { |
||||
|
"title": "Detail", |
||||
|
"type": "array", |
||||
|
"items": {"$ref": "#/components/schemas/ValidationError"}, |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
} |
||||
|
}, |
||||
|
} |
||||
Loading…
Reference in new issue