Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 35 for NOTICE (0.04 sec)

  1. docs/en/docs/tutorial/path-operation-configuration.md

    # Path Operation Configuration { #path-operation-configuration }
    
    There are several parameters that you can pass to your *path operation decorator* to configure it.
    
    /// warning
    
    Notice that these parameters are passed directly to the *path operation decorator*, not to your *path operation function*.
    
    ///
    
    ## Response Status Code { #response-status-code }
    
    You can define the (HTTP) `status_code` to be used in the response of your *path operation*.
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 4.1K bytes
    - Viewed (0)
  2. docs/en/docs/tutorial/body-multiple-params.md

    And you can also declare body parameters as optional, by setting the default to `None`:
    
    {* ../../docs_src/body_multiple_params/tutorial001_an_py310.py hl[18:20] *}
    
    /// note
    
    Notice that, in this case, the `item` that would be taken from the body is optional. As it has a `None` default value.
    
    ///
    
    ## Multiple body parameters { #multiple-body-parameters }
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 4.9K bytes
    - Viewed (0)
  3. docs/en/docs/advanced/generate-clients.md

    Now you can import and use the client code. It could look like this, notice that you get autocompletion for the methods:
    
    <img src="/img/tutorial/generate-clients/image02.png">
    
    You will also get autocompletion for the payload to send:
    
    <img src="/img/tutorial/generate-clients/image03.png">
    
    /// tip
    
    Notice the autocompletion for `name` and `price`, that was defined in the FastAPI application, in the `Item` model.
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 10.1K bytes
    - Viewed (0)
  4. docs/en/docs/tutorial/query-params.md

    {* ../../docs_src/query_params/tutorial002_py310.py hl[7] *}
    
    In this case, the function parameter `q` will be optional, and will be `None` by default.
    
    /// check
    
    Also notice that **FastAPI** is smart enough to notice that the path parameter `item_id` is a path parameter and `q` is not, so, it's a query parameter.
    
    ///
    
    ## Query parameter type conversion { #query-parameter-type-conversion }
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 10:29:01 UTC 2025
    - 4.5K bytes
    - Viewed (0)
  5. docs/en/docs/tutorial/dependencies/classes-as-dependencies.md

    ```Python
    something()
    ```
    
    or
    
    ```Python
    something(some_argument, some_keyword_argument="foo")
    ```
    
    then it is a "callable".
    
    ## Classes as dependencies { #classes-as-dependencies_1 }
    
    You might notice that to create an instance of a Python class, you use that same syntax.
    
    For example:
    
    ```Python
    class Cat:
        def __init__(self, name: str):
            self.name = name
    
    
    fluffy = Cat(name="Mr Fluffy")
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 6.7K bytes
    - Viewed (0)
  6. docs/en/docs/advanced/events.md

    Maybe you need to start a new version, or you just got tired of running it. 🤷
    
    ///
    
    ### Lifespan function { #lifespan-function }
    
    The first thing to notice, is that we are defining an async function with `yield`. This is very similar to Dependencies with `yield`.
    
    {* ../../docs_src/events/tutorial003.py hl[14:19] *}
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 7.9K bytes
    - Viewed (0)
  7. docs/en/docs/tutorial/path-params.md

    ```JSON
    {"item_id":3}
    ```
    
    /// check
    
    Notice that the value your function received (and returned) is `3`, as a Python `int`, not a string `"3"`.
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 10:29:01 UTC 2025
    - 9.3K bytes
    - Viewed (0)
  8. docs/en/docs/how-to/configure-swagger-ui.md

    <img src="/img/tutorial/extending-openapi/image03.png">
    
    ## Change the Theme { #change-the-theme }
    
    The same way you could set the syntax highlighting theme with the key `"syntaxHighlight.theme"` (notice that it has a dot in the middle):
    
    {* ../../docs_src/configure_swagger_ui/tutorial002.py hl[3] *}
    
    That configuration would change the syntax highlighting color theme:
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 2.9K bytes
    - Viewed (0)
  9. docs/en/docs/tutorial/body-fields.md

    ## Import `Field` { #import-field }
    
    First, you have to import it:
    
    {* ../../docs_src/body_fields/tutorial001_an_py310.py hl[4] *}
    
    
    /// warning
    
    Notice that `Field` is imported directly from `pydantic`, not from `fastapi` as are all the rest (`Query`, `Path`, `Body`, etc).
    
    ///
    
    ## Declare model attributes { #declare-model-attributes }
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 2.3K bytes
    - Viewed (0)
  10. docs/en/docs/tutorial/dependencies/sub-dependencies.md

    ## Use the dependency { #use-the-dependency }
    
    Then we can use the dependency with:
    
    {* ../../docs_src/dependencies/tutorial005_an_py310.py hl[23] *}
    
    /// info
    
    Notice that we are only declaring one dependency in the *path operation function*, the `query_or_cookie_extractor`.
    
    Registered: Sun Sep 07 07:19:17 UTC 2025
    - Last Modified: Sun Aug 31 09:15:41 UTC 2025
    - 3.7K bytes
    - Viewed (0)
Back to top