Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 8 of 8 for customize (0.16 sec)

  1. docs/en/docs/how-to/general.md

    To add metadata to your OpenAPI schema, including a license, version, contact, etc, read the docs for [Tutorial - Metadata and Docs URLs](../tutorial/metadata.md){.internal-link target=_blank}.
    
    ## OpenAPI Custom URL
    
    To customize the OpenAPI URL (or remove it), read the docs for [Tutorial - Metadata and Docs URLs](../tutorial/metadata.md#openapi-url){.internal-link target=_blank}.
    
    ## OpenAPI Docs URLs
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Sat Aug 19 19:54:04 GMT 2023
    - 2.3K bytes
    - Viewed (0)
  2. docs/en/docs/advanced/generate-clients.md

    ### Custom Generate Unique ID Function
    
    FastAPI uses a **unique ID** for each *path operation*, it is used for the **operation ID** and also for the names of any needed custom models, for requests or responses.
    
    You can customize that function. It takes an `APIRoute` and outputs a string.
    
    For example, here it is using the first tag (you will probably have only one tag) and the *path operation* name (the function name).
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 10.5K bytes
    - Viewed (0)
  3. fastapi/security/oauth2.py

            )
    
    
    class OAuth2(SecurityBase):
        """
        This is the base class for OAuth2 authentication, an instance of it would be used
        as a dependency. All other OAuth2 classes inherit from it and customize it for
        each OAuth2 flow.
    
        You normally would not create a new class inheriting from it but use one of the
        existing subclasses, and maybe compose them if you want to support multiple flows.
    
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Apr 02 02:48:51 GMT 2024
    - 21.1K bytes
    - Viewed (1)
  4. docs/en/docs/tutorial/metadata.md

    # Metadata and Docs URLs
    
    You can customize several metadata configurations in your **FastAPI** application.
    
    ## Metadata for API
    
    You can set the following fields that are used in the OpenAPI specification and the automatic API docs UIs:
    
    | Parameter | Type | Description |
    |------------|------|-------------|
    | `title` | `str` | The title of the API. |
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Sun Mar 31 23:52:53 GMT 2024
    - 5.8K bytes
    - Viewed (0)
  5. fastapi/applications.py

                    """
                ),
            ] = None,
            generate_unique_id_function: Annotated[
                Callable[[routing.APIRoute], str],
                Doc(
                    """
                    Customize the function used to generate unique IDs for the *path
                    operations* shown in the generated OpenAPI.
    
                    This is particularly useful when automatically generating clients or
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Apr 02 02:48:51 GMT 2024
    - 172.2K bytes
    - Viewed (0)
  6. fastapi/routing.py

                    """
                ),
            ] = True,
            generate_unique_id_function: Annotated[
                Callable[[APIRoute], str],
                Doc(
                    """
                    Customize the function used to generate unique IDs for the *path
                    operations* shown in the generated OpenAPI.
    
                    This is particularly useful when automatically generating clients or
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Apr 02 02:48:51 GMT 2024
    - 170.1K bytes
    - Viewed (0)
  7. docs/en/docs/how-to/custom-docs-ui-assets.md

    But it's possible to customize it, you can set a specific CDN, or serve the files yourself.
    
    ## Custom CDN for JavaScript and CSS
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Mon Oct 30 09:58:58 GMT 2023
    - 7.5K bytes
    - Viewed (0)
  8. docs/en/docs/release-notes.md

        * PR [#278](https://github.com/tiangolo/fastapi/pull/278).
    
    ## 0.26.0
    
    * Separate error handling for validation errors.
        * This will allow developers to customize the exception handlers.
        * Document better how to handle exceptions and use error handlers.
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri May 03 23:25:42 GMT 2024
    - 388.1K bytes
    - Viewed (1)
Back to top