Search Options

Results per page
Sort
Preferred Languages
Advance

Results 11 - 20 of 29 for APIRoute (0.05 sec)

  1. tests/test_generate_unique_id_function.py

    from fastapi import APIRouter, FastAPI
    from fastapi.routing import APIRoute
    from fastapi.testclient import TestClient
    from pydantic import BaseModel
    
    
    def custom_generate_unique_id(route: APIRoute):
        return f"foo_{route.name}"
    
    
    def custom_generate_unique_id2(route: APIRoute):
        return f"bar_{route.name}"
    
    
    def custom_generate_unique_id3(route: APIRoute):
        return f"baz_{route.name}"
    
    
    class Item(BaseModel):
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sat Jan 13 15:10:26 UTC 2024
    - 66.7K bytes
    - Viewed (0)
  2. docs_src/custom_request_and_route/tutorial001.py

    from fastapi.routing import APIRoute
    
    
    class GzipRequest(Request):
        async def body(self) -> bytes:
            if not hasattr(self, "_body"):
                body = await super().body()
                if "gzip" in self.headers.getlist("Content-Encoding"):
                    body = gzip.decompress(body)
                self._body = body
            return self._body
    
    
    class GzipRoute(APIRoute):
        def get_route_handler(self) -> Callable:
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Fri May 13 23:38:22 UTC 2022
    - 973 bytes
    - Viewed (0)
  3. docs_src/generate_clients/tutorial003_py39.py

    from fastapi import FastAPI
    from fastapi.routing import APIRoute
    from pydantic import BaseModel
    
    
    def custom_generate_unique_id(route: APIRoute):
        return f"{route.tags[0]}-{route.name}"
    
    
    app = FastAPI(generate_unique_id_function=custom_generate_unique_id)
    
    
    class Item(BaseModel):
        name: str
        price: float
    
    
    class ResponseMessage(BaseModel):
        message: str
    
    
    class User(BaseModel):
        username: str
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Fri Mar 04 22:02:18 UTC 2022
    - 914 bytes
    - Viewed (0)
  4. 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:
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Tue Sep 17 18:54:10 UTC 2024
    - 22.6K bytes
    - Viewed (0)
  5. fastapi/utils.py

    from pydantic import BaseModel, create_model
    from pydantic.fields import FieldInfo
    from typing_extensions import Literal
    
    if TYPE_CHECKING:  # pragma: nocover
        from .routing import APIRoute
    
    # Cache for `create_cloned_field`
    _CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (
        WeakKeyDictionary()
    )
    
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sat Aug 31 23:46:03 UTC 2024
    - 7.8K bytes
    - Viewed (0)
  6. fastapi/routing.py

            route_class: Annotated[
                Type[APIRoute],
                Doc(
                    """
                    Custom route (*path operation*) class to be used by this router.
    
                    Read more about it in the
                    [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).
                    """
                ),
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sat Oct 12 09:44:57 UTC 2024
    - 172.1K bytes
    - Viewed (0)
  7. docs/ja/docs/advanced/path-operation-advanced-configuration.md

    {!../../docs_src/path_operation_advanced_configuration/tutorial001.py!}
    ```
    
    ### *path operation関数* の名前をoperationIdとして使用する
    
    APIの関数名を `operationId` として利用したい場合、すべてのAPIの関数をイテレーションし、各 *path operation* の `operationId` を `APIRoute.name` で上書きすれば可能です。
    
    そうする場合は、すべての *path operation* を追加した後に行う必要があります。
    
    ```Python hl_lines="2  12-21  24"
    {!../../docs_src/path_operation_advanced_configuration/tutorial002.py!}
    ```
    
    /// tip | "豆知識"
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 2.3K bytes
    - Viewed (0)
  8. docs/zh/docs/advanced/path-operation-advanced-configuration.md

    ```Python hl_lines="6"
    {!../../docs_src/path_operation_advanced_configuration/tutorial001.py!}
    ```
    
    ### 使用 *路径操作函数* 的函数名作为 operationId
    
    如果你想用你的 API 的函数名作为 `operationId` 的名字,你可以遍历一遍 API 的函数名,然后使用他们的 `APIRoute.name` 重写每个 *路径操作* 的 `operation_id`。
    
    你应该在添加了所有 *路径操作* 之后执行此操作。
    
    ```Python hl_lines="2 12 13 14 15 16 17 18 19 20 21 24"
    {!../../docs_src/path_operation_advanced_configuration/tutorial002.py!}
    ```
    
    /// tip
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 1.9K bytes
    - Viewed (0)
  9. docs/es/docs/advanced/path-operation-advanced-configuration.md

    Si quieres usar tus nombres de funciones de API como `operationId`s, puedes iterar sobre todos ellos y sobrescribir `operation_id` de cada *operación de path* usando su `APIRoute.name`.
    
    Deberías hacerlo después de adicionar todas tus *operaciones de path*.
    
    ```Python hl_lines="2 12 13 14 15 16 17 18 19 20 21 24"
    {!../../docs_src/path_operation_advanced_configuration/tutorial002.py!}
    ```
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 2.1K bytes
    - Viewed (0)
  10. docs/en/docs/advanced/path-operation-advanced-configuration.md

    ```
    
    ### Using the *path operation function* name as the operationId
    
    If you want to use your APIs' function names as `operationId`s, you can iterate over all of them and override each *path operation's* `operation_id` using their `APIRoute.name`.
    
    You should do it after adding all your *path operations*.
    
    ```Python hl_lines="2  12-21  24"
    {!../../docs_src/path_operation_advanced_configuration/tutorial002.py!}
    ```
    
    /// tip
    
    Registered: Sun Nov 03 07:19:11 UTC 2024
    - Last Modified: Sun Oct 06 20:36:54 UTC 2024
    - 7.6K bytes
    - Viewed (0)
Back to top