Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 80 for generateId (0.16 sec)

  1. docs/en/docs/advanced/generate-clients.md

        {!> ../../../docs_src/generate_clients/tutorial002_py39.py!}
        ```
    
    === "Python 3.8+"
    
        ```Python hl_lines="23  28  36"
        {!> ../../../docs_src/generate_clients/tutorial002.py!}
        ```
    
    ### Generate a TypeScript Client with Tags
    
    If you generate a client for a FastAPI app using tags, it will normally also separate the client code based on the tags.
    
    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)
  2. fastapi/param_functions.py

                It will affect the generated OpenAPI (e.g. visible at `/docs`).
                """
            ),
        ] = None,
        include_in_schema: Annotated[
            bool,
            Doc(
                """
                To include (or not) this parameter field in the generated OpenAPI.
                You probably don't need it, but it's available.
    
                This affects the generated OpenAPI (e.g. visible at `/docs`).
    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)
  3. docs/en/docs/tutorial/middleware.md

    You can add code to be run with the `request`,  before any *path operation* receives it.
    
    And also after the `response` is generated, before returning it.
    
    For example, you could add a custom header `X-Process-Time` containing the time in seconds that it took to process the request and generate a response:
    
    ```Python hl_lines="10  12-13"
    {!../../../docs_src/middleware/tutorial001.py!}
    ```
    
    ## Other middlewares
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Jan 11 16:31:18 GMT 2024
    - 2.9K bytes
    - Viewed (0)
  4. docs/en/docs/alternatives.md

    And it generates OpenAPI schemas.
    
    That's how it works in Flask, Starlette, Responder, etc.
    
    But then, we have again the problem of having a micro-syntax, inside of a Python string (a big YAML).
    
    The editor can't help much with that. And if we modify parameters or Marshmallow schemas and forget to also modify that YAML docstring, the generated schema would be obsolete.
    
    !!! info
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 23.2K bytes
    - Viewed (0)
  5. docs/en/docs/contributing.md

    ## Tests
    
    There is a script that you can run locally to test all the code and generate coverage reports in HTML:
    
    <div class="termy">
    
    ```console
    $ bash scripts/test-cov-html.sh
    ```
    
    </div>
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Jan 11 17:42:43 GMT 2024
    - 14.1K bytes
    - Viewed (0)
  6. fastapi/security/http.py

                    It will be included in the generated OpenAPI (e.g. visible at `/docs`).
                    """
                ),
            ] = None,
            description: Annotated[
                Optional[str],
                Doc(
                    """
                    Security scheme description.
    
                    It will be included in the generated OpenAPI (e.g. visible at `/docs`).
                    """
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri Apr 19 15:29:38 GMT 2024
    - 13.2K bytes
    - Viewed (0)
  7. fastapi/security/oauth2.py

                    It will be included in the generated OpenAPI (e.g. visible at `/docs`).
                    """
                ),
            ] = None,
            description: Annotated[
                Optional[str],
                Doc(
                    """
                    Security scheme description.
    
                    It will be included in the generated OpenAPI (e.g. visible at `/docs`).
                    """
    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)
  8. docs/en/docs/tutorial/first-steps.md

    ![ReDoc](https://fastapi.tiangolo.com/img/index/index-02-redoc-simple.png)
    
    ### OpenAPI
    
    **FastAPI** generates a "schema" with all your API using the **OpenAPI** standard for defining APIs.
    
    #### "Schema"
    
    A "schema" is a definition or description of something. Not the code that implements it, but just an abstract description.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu May 02 22:37:31 GMT 2024
    - 12K bytes
    - Viewed (0)
  9. docs/en/docs/tutorial/body-fields.md

    ## Add extra information
    
    You can declare extra information in `Field`, `Query`, `Body`, etc. And it will be included in the generated JSON Schema.
    
    You will learn more about adding extra information later in the docs, when learning to declare examples.
    
    !!! warning
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Oct 17 05:59:11 GMT 2023
    - 3.6K bytes
    - Viewed (0)
  10. docs/en/docs/advanced/behind-a-proxy.md

                "description": "Production environment"
            }
        ],
        "paths": {
                // More stuff here
        }
    }
    ```
    
    !!! tip
        Notice the auto-generated server with a `url` value of `/api/v1`, taken from the `root_path`.
    
    In the docs UI at <a href="http://127.0.0.1:9999/api/v1/docs" class="external-link" target="_blank">http://127.0.0.1:9999/api/v1/docs</a> it would look like:
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu May 02 22:37:31 GMT 2024
    - 11.6K bytes
    - Viewed (2)
Back to top