Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 413 for parameter (0.14 sec)

  1. tests/test_repeated_parameter_alias.py

    from fastapi.testclient import TestClient
    
    app = FastAPI()
    
    
    @app.get("/{repeated_alias}")
    def get_parameters_with_repeated_aliases(
        path: str = Path(..., alias="repeated_alias"),
        query: str = Query(..., alias="repeated_alias"),
    ):
        return {"path": path, "query": query}
    
    
    client = TestClient(app)
    
    
    def test_get_parameters():
        response = client.get("/test_path", params={"repeated_alias": "test_query"})
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri Jun 30 18:25:16 GMT 2023
    - 3.7K bytes
    - Viewed (0)
  2. tests/test_openapi_query_parameter_extension.py

            "paths": {
                "/": {
                    "get": {
                        "summary": "Route With Extra Query Parameters",
                        "operationId": "route_with_extra_query_parameters__get",
                        "parameters": [
                            {
                                "required": False,
                                "schema": IsDict(
                                    {
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri Jul 07 17:12:13 GMT 2023
    - 4.7K bytes
    - Viewed (0)
  3. tests/test_enforce_once_required_parameter.py

        },
        "info": {"title": "FastAPI", "version": "0.1.0"},
        "openapi": "3.1.0",
        "paths": {
            "/foo": {
                "get": {
                    "operationId": "foo_handler_foo_get",
                    "parameters": [
                        {
                            "in": "query",
                            "name": "client_id",
                            "required": True,
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri Jun 30 18:25:16 GMT 2023
    - 3.4K bytes
    - Viewed (0)
  4. fastapi/param_functions.py

    _Unset: Any = Undefined
    
    
    def Path(  # noqa: N802
        default: Annotated[
            Any,
            Doc(
                """
                Default value if the parameter field is not set.
    
                This doesn't affect `Path` parameters as the value is always required.
                The parameter is available only for compatibility.
                """
            ),
        ] = ...,
        *,
        default_factory: Annotated[
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:40:57 GMT 2024
    - 62.5K bytes
    - Viewed (0)
  5. 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
    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)
  6. docs/en/docs/tutorial/response-model.md

    In those cases, you can use the *path operation decorator* parameter `response_model` instead of the return type.
    
    You can use the `response_model` parameter in any of the *path operations*:
    
    * `@app.get()`
    * `@app.post()`
    * `@app.put()`
    * `@app.delete()`
    * etc.
    
    === "Python 3.10+"
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 17.9K bytes
    - Viewed (0)
  7. docs/de/docs/advanced/openapi-callbacks.md

    Dieser Teil ist ziemlich normal, der größte Teil des Codes ist Ihnen wahrscheinlich bereits bekannt:
    
    ```Python hl_lines="9-13  36-53"
    {!../../../docs_src/openapi_callbacks/tutorial001.py!}
    ```
    
    !!! tip "Tipp"
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Sat Mar 30 20:17:23 GMT 2024
    - 8.8K bytes
    - Viewed (0)
  8. docs/en/docs/reference/request.md

    # `Request` class
    
    You can declare a parameter in a *path operation function* or dependency to be of type `Request` and then you can access the raw request object directly, without any validation, etc.
    
    You can import it directly from `fastapi`:
    
    ```python
    from fastapi import Request
    ```
    
    !!! tip
    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)
  9. docs/en/docs/tutorial/testing.md

    E.g.:
    
    * To pass a *path* or *query* parameter, add it to the URL itself.
    * To pass a JSON body, pass a Python object (e.g. a `dict`) to the parameter `json`.
    * If you need to send *Form Data* instead of JSON, use the `data` parameter instead.
    * To pass *headers*, use a `dict` in the `headers` parameter.
    * For *cookies*, a `dict` in the `cookies` parameter.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 6.2K bytes
    - Viewed (0)
  10. docs/en/docs/advanced/dataclasses.md

        But if you have a bunch of dataclasses laying around, this is a nice trick to use them to power a web API using FastAPI. 🤓
    
    ## Dataclasses in `response_model`
    
    You can also use `dataclasses` in the `response_model` parameter:
    
    ```Python hl_lines="1  7-13  19"
    {!../../../docs_src/dataclasses/tutorial002.py!}
    ```
    
    The dataclass will be automatically converted to a Pydantic dataclass.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 4.1K bytes
    - Viewed (0)
Back to top