Search Options

Results per page
Sort
Preferred Languages
Advance

Results 31 - 40 of 1,235 for _parameters (0.09 sec)

  1. docs/en/docs/tutorial/request-files.md

    ///
    
    /// tip
    
    To declare File bodies, you need to use `File`, because otherwise the parameters would be interpreted as query parameters or body (JSON) parameters.
    
    ///
    
    The files will be uploaded as "form data".
    
    If you declare the type of your *path operation function* parameter as `bytes`, **FastAPI** will read the file for you and you will receive the contents as `bytes`.
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 10.2K bytes
    - Viewed (0)
  2. docs/en/docs/tutorial/path-params.md

    ```
    /files/{file_path:path}
    ```
    
    In this case, the name of the parameter is `file_path`, and the last part, `:path`, tells it that the parameter should match any *path*.
    
    So, you can use it with:
    
    ```Python hl_lines="6"
    {!../../docs_src/path_params/tutorial004.py!}
    ```
    
    /// tip
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 9.1K bytes
    - Viewed (0)
  3. fastapi/openapi/utils.py

                if openapi_examples:
                    parameter["examples"] = jsonable_encoder(openapi_examples)
                elif example != Undefined:
                    parameter["example"] = jsonable_encoder(example)
                if getattr(field_info, "deprecated", None):
                    parameter["deprecated"] = True
                parameters.append(parameter)
        return parameters
    
    
    def get_openapi_operation_request_body(
        *,
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Tue Sep 17 18:54:10 UTC 2024
    - 22.6K bytes
    - Viewed (0)
  4. docs/en/docs/tutorial/path-operation-configuration.md

    # 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
    
    You can define the (HTTP) `status_code` to be used in the response of your *path operation*.
    
    You can pass directly the `int` code, like `404`.
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 5.4K bytes
    - Viewed (0)
  5. compat/maven-plugin-api/src/test/resources/plugin.xml

          <configurator>antrun</configurator>
          <parameters>
            <parameter>
              <name>finalName</name>
              <alias>jarName</alias>
              <type>java.lang.String</type>
              <implementation>java.lang.String</implementation>
              <required>false</required>
              <editable>true</editable>
              <description>parameter-description</description>
    Registered: Sun Nov 03 03:35:11 UTC 2024
    - Last Modified: Fri Oct 25 12:31:46 UTC 2024
    - 3.3K bytes
    - Viewed (0)
  6. docs/en/docs/index.md

    * The alternative documentation will also reflect the new query parameter and body:
    
    ![ReDoc](https://fastapi.tiangolo.com/img/index/index-06-redoc-02.png)
    
    ### Recap
    
    In summary, you declare **once** the types of parameters, body, etc. as function parameters.
    
    You do that with standard modern Python types.
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 20 19:20:23 UTC 2024
    - 20.4K bytes
    - Viewed (0)
  7. docs/en/docs/advanced/advanced-dependencies.md

    In this case, this `__call__` is what **FastAPI** will use to check for additional parameters and sub-dependencies, and this is what will be called to pass a value to the parameter in your *path operation function* later.
    
    ## Parameterize the instance
    
    And now, we can use `__init__` to declare the parameters of the instance that we can use to "parameterize" the dependency:
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 27 16:10:15 UTC 2024
    - 2.4K bytes
    - Viewed (0)
  8. README.md

    * The alternative documentation will also reflect the new query parameter and body:
    
    ![ReDoc](https://fastapi.tiangolo.com/img/index/index-06-redoc-02.png)
    
    ### Recap
    
    In summary, you declare **once** the types of parameters, body, etc. as function parameters.
    
    You do that with standard modern Python types.
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Thu Oct 31 09:13:26 UTC 2024
    - 23.6K bytes
    - Viewed (0)
  9. docs/en/docs/tutorial/header-params.md

    # Header Parameters
    
    You can define Header parameters the same way you define `Query`, `Path` and `Cookie` parameters.
    
    ## Import `Header`
    
    First import `Header`:
    
    //// tab | Python 3.10+
    
    ```Python hl_lines="3"
    {!> ../../docs_src/header_params/tutorial001_an_py310.py!}
    ```
    
    ////
    
    //// tab | Python 3.9+
    
    ```Python hl_lines="3"
    {!> ../../docs_src/header_params/tutorial001_an_py39.py!}
    ```
    
    ////
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 5.6K bytes
    - Viewed (0)
  10. docs/en/docs/tutorial/header-param-models.md

    # Header Parameter Models
    
    If you have a group of related **header parameters**, you can create a **Pydantic model** to declare them.
    
    This would allow you to **re-use the model** in **multiple places** and also to declare validations and metadata for all the parameters at once. 😎
    
    /// note
    
    This is supported since FastAPI version `0.115.0`. 🤓
    
    ///
    
    ## Header Parameters with a Pydantic Model
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 3.5K bytes
    - Viewed (0)
Back to top