- Sort Score
- Result 10 results
- Languages All
Results 1 - 10 of 120 for Define (0.14 sec)
-
docs/en/docs/reference/request.md
You can import it directly from `fastapi`: ```python from fastapi import Request ``` !!! tip When you want to define dependencies that should be compatible with both HTTP and WebSockets, you can define a parameter that takes an `HTTPConnection` instead of a `Request` or a `WebSocket`.
Plain Text - Registered: Sun May 05 07:19:11 GMT 2024 - Last Modified: Thu Apr 18 19:53:19 GMT 2024 - 516 bytes - Viewed (0) -
docs/en/docs/tutorial/first-steps.md
#### API "schema" In this case, <a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a> is a specification that dictates how to define a schema of your API. This schema definition includes your API paths, the possible parameters they take, etc. #### Data "schema" The term "schema" might also refer to the shape of some data, like a JSON content.
Plain Text - Registered: Sun May 05 07:19:11 GMT 2024 - Last Modified: Thu May 02 22:37:31 GMT 2024 - 12K bytes - Viewed (0) -
docs/en/docs/alternatives.md
But it was created before there existed Python type hints. So, to define every <abbr title="the definition of how data should be formed">schema</abbr> you need to use specific utils and classes provided by Marshmallow. !!! check "Inspired **FastAPI** to" Use code to define "schemas" that provide data types and validation, automatically.
Plain Text - Registered: Sun May 05 07:19:11 GMT 2024 - Last Modified: Thu Apr 18 19:53:19 GMT 2024 - 23.2K bytes - Viewed (0) -
docs/en/docs/reference/websockets.md
It is provided directly by Starlette, but you can import it from `fastapi`: ```python from fastapi import WebSocket ``` !!! tip When you want to define dependencies that should be compatible with both HTTP and WebSockets, you can define a parameter that takes an `HTTPConnection` instead of a `Request` or a `WebSocket`. ::: fastapi.WebSocket options: members: - scope - app
Plain Text - Registered: Sun May 05 07:19:11 GMT 2024 - Last Modified: Thu Apr 18 19:53:19 GMT 2024 - 1.6K bytes - Viewed (0) -
docs/en/docs/tutorial/request-forms-and-files.md
# Request Forms and Files You can define files and form fields at the same time using `File` and `Form`. !!! info To receive uploaded files and/or form data, first install <a href="https://github.com/Kludex/python-multipart" class="external-link" target="_blank">`python-multipart`</a>. E.g. `pip install python-multipart`. ## Import `File` and `Form` === "Python 3.9+" ```Python hl_lines="3"
Plain Text - Registered: Sun May 05 07:19:11 GMT 2024 - Last Modified: Wed Mar 13 19:02:19 GMT 2024 - 2K bytes - Viewed (0) -
docs/en/docs/reference/uploadfile.md
# `UploadFile` class You can define *path operation function* parameters to be of the type `UploadFile` to receive files from the request. You can import it directly from `fastapi`: ```python from fastapi import UploadFile ``` ::: fastapi.UploadFile options: members: - file - filename - size - headers - content_type - read
Plain Text - Registered: Sun May 05 07:19:11 GMT 2024 - Last Modified: Thu Apr 18 19:53:19 GMT 2024 - 472 bytes - Viewed (0) -
docs/en/docs/advanced/openapi-webhooks.md
This is normally called a **webhook**. ## Webhooks steps The process normally is that **you define** in your code what is the message that you will send, the **body of the request**. You also define in some way at which **moments** your app will send those requests or events. And **your users** define in some way (for example in a web dashboard somewhere) the **URL** where your app should send those requests.
Plain Text - Registered: Sun May 05 07:19:11 GMT 2024 - Last Modified: Thu May 02 22:37:31 GMT 2024 - 2.8K bytes - Viewed (0) -
docs/en/docs/python-types.md
If you can use the **latest versions of Python**, use the examples for the latest version, those will have the **best and simplest syntax**, for example, "**Python 3.10+**". #### List For example, let's define a variable to be a `list` of `str`. === "Python 3.9+" Declare the variable, with the same colon (`:`) syntax. As the type, put `list`.
Plain Text - Registered: Sun May 05 07:19:11 GMT 2024 - Last Modified: Thu Apr 18 19:53:19 GMT 2024 - 17K bytes - Viewed (0) -
docs/en/docs/advanced/generate-clients.md
``` === "Python 3.8+" ```Python hl_lines="9-11 14-15 18 19 23" {!> ../../../docs_src/generate_clients/tutorial001.py!} ``` Notice that the *path operations* define the models they use for request payload and response payload, using the models `Item` and `ResponseMessage`. ### API Docs
Plain Text - Registered: Sun May 05 07:19:11 GMT 2024 - Last Modified: Thu Apr 18 19:53:19 GMT 2024 - 10.5K bytes - Viewed (0) -
docs/en/docs/tutorial/path-params.md
### OpenAPI support OpenAPI doesn't support a way to declare a *path parameter* to contain a *path* inside, as that could lead to scenarios that are difficult to test and define. Nevertheless, you can still do it in **FastAPI**, using one of the internal tools from Starlette. And the docs would still work, although not adding any documentation telling that the parameter should contain a path.
Plain Text - Registered: Sun May 05 07:19:11 GMT 2024 - Last Modified: Fri Mar 22 01:42:11 GMT 2024 - 9.1K bytes - Viewed (0)