From dd2541bc97bfd507b7f288239e2aa1fdcbc845d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Wed, 26 Dec 2018 19:01:15 +0400 Subject: [PATCH] :memo: Improve explanation of request bodies --- README.md | 4 ++-- docs/index.md | 2 +- docs/tutorial/body.md | 13 ++++++++++++- docs/tutorial/intro.md | 4 ++-- 4 files changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7020bcdbf..526ac7bbb 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ The key features are: * **Easy**: Designed to be easy to use and learn. Less time reading docs. * **Short**: Minimize code duplication. Multiple features from each parameter declaration. Less bugs. * **Robust**: Get production-ready code. With automatic interactive documentation. -* **Standards-based**: Based on (and fully compatible with) the open standards for APIs: OpenAPI and JSON Schema. +* **Standards-based**: Based on (and fully compatible with) the open standards for APIs: OpenAPI (previously known as Swagger) and JSON Schema. * estimation based on tests on an internal development team, building production applications. @@ -366,7 +366,7 @@ Used by FastAPI / Starlette: * uvicorn - for the server that loads and serves your application. -You can install all of these with `pip3 install fastapi[full]`. +You can install all of these with `pip3 install fastapi[all]`. ## License diff --git a/docs/index.md b/docs/index.md index 14be55d6f..526ac7bbb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -366,7 +366,7 @@ Used by FastAPI / Starlette: * uvicorn - for the server that loads and serves your application. -You can install all of these with `pip3 install fastapi[full]`. +You can install all of these with `pip3 install fastapi[all]`. ## License diff --git a/docs/tutorial/body.md b/docs/tutorial/body.md index d77510f46..98b1bfd45 100644 --- a/docs/tutorial/body.md +++ b/docs/tutorial/body.md @@ -1,4 +1,15 @@ -To declare a request body, you use Pydantic models with all their power and benefits. +When you need to send data from a client (let's say, a browser) to your API, you send it as a **request body**. + +A **request** body is data sent by the client to your API. A **response** body is the data your API sends to the client. + +Your API almost always has to send a **response** body. But clients don't necessarily need to send **request** bodies all the time. + +To declare a **request** body, you use Pydantic models with all their power and benefits. + +!!! info + You cannot send a request body using a `GET` operation (HTTP method). + + To send data, you have to use one of: `POST` (the more common), `PUT`, `DELETE` or `PATCH`. ## Import Pydantic's `BaseModel` diff --git a/docs/tutorial/intro.md b/docs/tutorial/intro.md index 04028e664..2faead19d 100644 --- a/docs/tutorial/intro.md +++ b/docs/tutorial/intro.md @@ -39,13 +39,13 @@ pip install fastapi[all] This is what you would probably do once you want to deploy your application to production: - ```bash + ``` pip install fastapi ``` Also install `uvicorn` to work as the server: - ```bash + ``` pip install uvicorn ```