Search Options

Display Count
Sort
Preferred Language
Advanced Search

Results 11 - 20 of 59 for apiNote (0.04 seconds)

  1. docs/en/docs/how-to/custom-request-and-route.md

    # Custom Request and APIRoute class { #custom-request-and-apiroute-class }
    
    In some cases, you may want to override the logic used by the `Request` and `APIRoute` classes.
    
    In particular, this may be a good alternative to logic in a middleware.
    
    For example, if you want to read or manipulate the request body before it is processed by your application.
    
    /// danger
    
    This is an "advanced" feature.
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 05 18:13:19 GMT 2026
    - 4.4K bytes
    - Click Count (0)
  2. docs/zh-hant/docs/how-to/custom-request-and-route.md

    # 自訂 Request 與 APIRoute 類別 { #custom-request-and-apiroute-class }
    
    在某些情況下,你可能想要覆寫 `Request` 與 `APIRoute` 類別所使用的邏輯。
    
    特別是,這可能是替代中介軟體(middleware)中實作邏輯的一個好方法。
    
    例如,如果你想在應用程式處理之前讀取或操作請求本文(request body)。
    
    /// danger
    
    這是進階功能。
    
    如果你剛開始使用 **FastAPI**,可以先跳過本節。
    
    ///
    
    ## 使用情境 { #use-cases }
    
    可能的使用情境包括:
    
    * 將非 JSON 的請求本文轉換為 JSON(例如 [`msgpack`](https://msgpack.org/index.html))。
    * 解壓縮以 gzip 壓縮的請求本文。
    * 自動記錄所有請求本文。
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Fri Mar 20 17:05:38 GMT 2026
    - 4.2K bytes
    - Click Count (0)
  3. docs/pt/docs/how-to/custom-request-and-route.md

    # Request e classe APIRoute personalizadas { #custom-request-and-apiroute-class }
    
    Em alguns casos, você pode querer sobrescrever a lógica usada pelas classes `Request` e `APIRoute`.
    
    Em particular, isso pode ser uma boa alternativa para uma lógica em um middleware.
    
    Por exemplo, se você quiser ler ou manipular o corpo da requisição antes que ele seja processado pela sua aplicação.
    
    /// danger | Cuidado
    
    Isso é um recurso "avançado".
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 19 18:20:43 GMT 2026
    - 4.9K bytes
    - Click Count (0)
  4. docs/fr/docs/how-to/custom-request-and-route.md

    # Personnaliser les classes Request et APIRoute { #custom-request-and-apiroute-class }
    
    Dans certains cas, vous pouvez vouloir surcharger la logique utilisée par les classes `Request` et `APIRoute`.
    
    En particulier, cela peut être une bonne alternative à une logique dans un middleware.
    
    Par exemple, si vous voulez lire ou manipuler le corps de la requête avant qu'il ne soit traité par votre application.
    
    /// danger | Danger
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 19 18:37:13 GMT 2026
    - 5.1K bytes
    - Click Count (0)
  5. docs/es/docs/how-to/custom-request-and-route.md

    # Clase personalizada de Request y APIRoute { #custom-request-and-apiroute-class }
    
    En algunos casos, puede que quieras sobrescribir la lógica utilizada por las clases `Request` y `APIRoute`.
    
    En particular, esta puede ser una buena alternativa a la lógica en un middleware.
    
    Por ejemplo, si quieres leer o manipular el request body antes de que sea procesado por tu aplicación.
    
    /// danger | Advertencia
    
    Esta es una funcionalidad "avanzada".
    
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 19 18:15:55 GMT 2026
    - 4.8K bytes
    - Click Count (0)
  6. docs_src/custom_request_and_route/tutorial002_py310.py

    from collections.abc import Callable
    
    from fastapi import Body, FastAPI, HTTPException, Request, Response
    from fastapi.exceptions import RequestValidationError
    from fastapi.routing import APIRoute
    
    
    class ValidationErrorLoggingRoute(APIRoute):
        def get_route_handler(self) -> Callable:
            original_route_handler = super().get_route_handler()
    
            async def custom_route_handler(request: Request) -> Response:
                try:
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Wed Dec 10 08:55:32 GMT 2025
    - 935 bytes
    - Click Count (0)
  7. docs_src/custom_request_and_route/tutorial003_py310.py

    import time
    from collections.abc import Callable
    
    from fastapi import APIRouter, FastAPI, Request, Response
    from fastapi.routing import APIRoute
    
    
    class TimedRoute(APIRoute):
        def get_route_handler(self) -> Callable:
            original_route_handler = super().get_route_handler()
    
            async def custom_route_handler(request: Request) -> Response:
                before = time.time()
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Wed Dec 10 08:55:32 GMT 2025
    - 1K bytes
    - Click Count (0)
  8. fastapi/openapi/utils.py

    
    def generate_operation_summary(*, route: routing.APIRoute, method: str) -> str:
        if route.summary:
            return route.summary
        return route.name.replace("_", " ").title()
    
    
    def get_openapi_operation_metadata(
        *, route: routing.APIRoute, method: str, operation_ids: set[str]
    ) -> dict[str, Any]:
        operation: dict[str, Any] = {}
        if route.tags:
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sun Mar 15 11:44:39 GMT 2026
    - 25.6K bytes
    - Click Count (0)
  9. tests/test_custom_route_class.py

    import pytest
    from fastapi import APIRouter, FastAPI
    from fastapi.routing import APIRoute
    from fastapi.testclient import TestClient
    from inline_snapshot import snapshot
    from starlette.routing import Route
    
    app = FastAPI()
    
    
    class APIRouteA(APIRoute):
        x_type = "A"
    
    
    class APIRouteB(APIRoute):
        x_type = "B"
    
    
    class APIRouteC(APIRoute):
        x_type = "C"
    
    
    router_a = APIRouter(route_class=APIRouteA)
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Sun Feb 08 10:18:38 GMT 2026
    - 3.3K bytes
    - Click Count (0)
  10. docs_src/path_operation_advanced_configuration/tutorial002_py310.py

    from fastapi import FastAPI
    from fastapi.routing import APIRoute
    
    app = FastAPI()
    
    
    @app.get("/items/")
    async def read_items():
        return [{"item_id": "Foo"}]
    
    
    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:
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Feb 12 13:19:43 GMT 2026
    - 572 bytes
    - Click Count (0)
Back to Top