Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 26 for Added (0.18 sec)

  1. fastapi/applications.py

                    It will be added to the generated OpenAPI (e.g. visible at `/docs`).
                    """
                ),
            ] = None,
            deprecated: Annotated[
                Optional[bool],
                Doc(
                    """
                    Mark this *path operation* as deprecated.
    
                    It will be added to the generated OpenAPI (e.g. visible at `/docs`).
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Tue Apr 02 02:48:51 GMT 2024
    - 172.2K bytes
    - Viewed (0)
  2. docs/en/docs/tutorial/schema-extra-example.md

    Before OpenAPI 3.1.0, OpenAPI used an older and modified version of **JSON Schema**.
    
    JSON Schema didn't have `examples`, so OpenAPI added it's own `example` field to its own modified version.
    
    OpenAPI also added `example` and `examples` fields to other parts of the specification:
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 11.8K bytes
    - Viewed (0)
  3. fastapi/routing.py

                    It will be added to the generated OpenAPI (e.g. visible at `/docs`).
                    """
                ),
            ] = None,
            deprecated: Annotated[
                Optional[bool],
                Doc(
                    """
                    Mark this *path operation* as deprecated.
    
                    It will be added to the generated OpenAPI (e.g. visible at `/docs`).
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Tue Apr 02 02:48:51 GMT 2024
    - 170.1K bytes
    - Viewed (0)
  4. docs/en/docs/advanced/events.md

    ```
    
    Here, the `shutdown` event handler function will write a text line `"Application shutdown"` to a file `log.txt`.
    
    !!! info
        In the `open()` function, the `mode="a"` means "append", so, the line will be added after whatever is on that file, without overwriting the previous contents.
    
    !!! tip
        Notice that in this case we are using a standard Python `open()` function that interacts with a file.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 7.8K bytes
    - Viewed (0)
  5. docs/en/docs/how-to/separate-openapi-schemas.md

    In that case, you can disable this feature in **FastAPI**, with the parameter `separate_input_output_schemas=False`.
    
    !!! info
        Support for `separate_input_output_schemas` was added in FastAPI `0.102.0`. 🤓
    
    === "Python 3.10+"
    
        ```Python hl_lines="10"
        {!> ../../../docs_src/separate_openapi_schemas/tutorial002_py310.py!}
        ```
    
    === "Python 3.9+"
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Tue Oct 17 05:59:11 GMT 2023
    - 6.7K bytes
    - Viewed (0)
  6. docs_src/path_operation_advanced_configuration/tutorial002.py

    
    def use_route_names_as_operation_ids(app: FastAPI) -> None:
        """
        Simplify operation IDs so that generated API clients have simpler function
        names.
    
        Should be called only after all routes have been added.
        """
        for route in app.routes:
            if isinstance(route, APIRoute):
                route.operation_id = route.name  # in this case, 'read_items'
    
    
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Mar 26 19:09:53 GMT 2020
    - 572 bytes
    - Viewed (0)
  7. docs/en/docs/tutorial/path-params-numeric-validations.md

        !!! tip
            Prefer to use the `Annotated` version if possible.
    
        ```Python hl_lines="3"
        {!> ../../../docs_src/path_params_numeric_validations/tutorial001.py!}
        ```
    
    !!! info
        FastAPI added support for `Annotated` (and started recommending it) in version 0.95.0.
    
        If you have an older version, you would get errors when trying to use `Annotated`.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Jan 11 16:31:18 GMT 2024
    - 9.1K bytes
    - Viewed (0)
  8. docs/en/docs/advanced/response-headers.md

        And as the `Response` can be used frequently to set headers and cookies, **FastAPI** also provides it at `fastapi.Response`.
    
    ## Custom Headers
    
    Keep in mind that custom proprietary headers can be added <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers" class="external-link" target="_blank">using the 'X-' prefix</a>.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Jan 11 16:31:18 GMT 2024
    - 2.2K bytes
    - Viewed (0)
  9. docs/en/docs/tutorial/sql-databases.md

        * Although it's probably not very problematic here with the way `SQLAlchemy` works.
        * But if you added more code to the middleware that had a lot of <abbr title="input and output">I/O</abbr> waiting, it could then be problematic.
    * A middleware is run for *every* request.
        * So, a connection will be created for every request.
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 29.6K bytes
    - Viewed (0)
  10. docs/en/docs/index.md

    
    @app.put("/items/{item_id}")
    def update_item(item_id: int, item: Item):
        return {"item_name": item.name, "item_id": item_id}
    ```
    
    The server should reload automatically (because you added `--reload` to the `uvicorn` command above).
    
    ### Interactive API docs upgrade
    
    Now go to <a href="http://127.0.0.1:8000/docs" class="external-link" target="_blank">http://127.0.0.1:8000/docs</a>.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 23:58:47 GMT 2024
    - 19.2K bytes
    - Viewed (0)
Back to top