Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 23 for describe (0.04 sec)

  1. docs/en/docs/how-to/separate-openapi-schemas.md

    That means that, clients using your API don't have to check if the value exists or not, they can **assume the field will always be there**, but just that in some cases it will have the default value of `None`.
    
    The way to describe this in OpenAPI, is to mark that field as **required**, because it will always be there.
    
    Because of that, the JSON Schema for a model can be different depending on if it's used for **input or output**:
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 4.6K bytes
    - Viewed (0)
  2. docs/en/docs/deployment/concepts.md

    ### What is a Program { #what-is-a-program }
    
    The word **program** is commonly used to describe many things:
    
    * The **code** that you write, the **Python files**.
    * The **file** that can be **executed** by the operating system, for example: `python`, `python.exe` or `uvicorn`.
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 18.6K bytes
    - Viewed (0)
  3. docs/en/docs/tutorial/schema-extra-example.md

    //// tab | Pydantic v2
    
    In Pydantic version 2, you would use the attribute `model_config`, that takes a `dict` as described in <a href="https://docs.pydantic.dev/latest/api/config/" class="external-link" target="_blank">Pydantic's docs: Configuration</a>.
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 9.6K bytes
    - Viewed (0)
  4. docs/en/docs/how-to/graphql.md

    ## Learn More { #learn-more }
    
    You can learn more about **GraphQL** in the <a href="https://graphql.org/" class="external-link" target="_blank">official GraphQL documentation</a>.
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 3.4K bytes
    - Viewed (0)
  5. docs/en/docs/tutorial/testing.md

    And your **FastAPI** application might also be composed of several files/modules, etc.
    
    ### **FastAPI** app file { #fastapi-app-file }
    
    Let's say you have a file structure as described in [Bigger Applications](bigger-applications.md){.internal-link target=_blank}:
    
    ```
    .
    ├── app
    │   ├── __init__.py
    │   └── main.py
    ```
    
    In the file `main.py` you have your **FastAPI** app:
    
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 6.6K bytes
    - Viewed (0)
  6. docs/en/docs/advanced/response-cookies.md

    ## Return a `Response` directly { #return-a-response-directly }
    
    You can also create cookies when returning a `Response` directly in your code.
    
    To do that, you can create a response as described in [Return a Response Directly](response-directly.md){.internal-link target=_blank}.
    
    Then set Cookies in it, and then return it:
    
    {* ../../docs_src/response_cookies/tutorial001.py hl[10:12] *}
    
    /// tip
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 2.2K bytes
    - Viewed (0)
  7. docs/en/docs/advanced/response-headers.md

    ## Return a `Response` directly { #return-a-response-directly }
    
    You can also add headers when you return a `Response` directly.
    
    Create a response as described in [Return a Response Directly](response-directly.md){.internal-link target=_blank} and pass the headers as an additional parameter:
    
    {* ../../docs_src/response_headers/tutorial001.py hl[10:12] *}
    
    /// note | Technical Details
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 2.3K bytes
    - Viewed (0)
  8. docs/en/docs/advanced/sub-applications.md

    ### Technical Details: `root_path` { #technical-details-root-path }
    
    When you mount a sub-application as described above, FastAPI will take care of communicating the mount path for the sub-application using a mechanism from the ASGI specification called a `root_path`.
    
    That way, the sub-application will know to use that path prefix for the docs UI.
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 3K bytes
    - Viewed (0)
  9. docs/en/docs/advanced/response-directly.md

    ## Notes { #notes }
    
    When you return a `Response` directly its data is not validated, converted (serialized), or documented automatically.
    
    But you can still document it as described in [Additional Responses in OpenAPI](additional-responses.md){.internal-link target=_blank}.
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 3.1K bytes
    - Viewed (0)
  10. docs/es/docs/async.md

    Pero si deseas usar `async` / `await` sin FastAPI, también puedes hacerlo.
    
    ### Escribe tu propio código async
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:56:21 UTC 2025
    - 24.7K bytes
    - Viewed (0)
Back to top