Reed - Code Search

docs/en/docs/tutorial/security/simple-oauth2.md

    If you need to enforce it, use `OAuth2PasswordRequestFormStrict` instead of `OAuth2PasswordRequestForm`.

* An optional `client_id` (we don't need it for our example).
* An optional `client_secret` (we don't need it for our example).

!!! info

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Thu Apr 18 19:53:19 GMT 2024

- 12.5K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/how-to/extending-openapi.md

# Extending OpenAPI

There are some cases where you might need to modify the generated OpenAPI schema.

In this section you will see how.

## The normal process

The normal (default) process, is as follows.

A `FastAPI` application (instance) has an `.openapi()` method that is expected to return the OpenAPI schema.

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Sat Aug 19 19:54:04 GMT 2023

- 3.2K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/advanced/security/oauth2-scopes.md

    You don't necessarily need OAuth2 scopes, and you can handle authentication and authorization however you want.

    But OAuth2 with scopes can be nicely integrated into your API (with OpenAPI) and your API docs.

    Nevertheless, you still enforce those scopes, or any other security/authorization requirement, however you need, in your code.

    In many cases, OAuth2 with scopes can be an overkill.

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Thu Jan 11 21:21:35 GMT 2024

- 20.5K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/advanced/response-directly.md

## Returning a custom `Response`

The example above shows all the parts you need, but it's not very useful yet, as you could have just returned the `item` directly, and **FastAPI** would put it in a `JSONResponse` for you, converting it to a `dict`, etc. All that by default.

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Sat Aug 29 14:02:58 GMT 2020

- 3K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/advanced/async-tests.md

function calls in your tests (e.g. when using <a href="https://stackoverflow.com/questions/41584243/runtimeerror-task-attached-to-a-different-loop" class="external-link" target="_blank">MongoDB's MotorClient</a>) Remember to instantiate objects that need an event loop only within async functions, e.g. an `'@app.on_event("startup")` callback....

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Sat Jan 13 12:07:15 GMT 2024

- 3.9K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/advanced/security/http-basic-auth.md

    ...
```

But right at the moment Python compares the first `j` in `johndoe` to the first `s` in `stanleyjobson`, it will return `False`, because it already knows that those two strings are not the same, thinking that "there's no need to waste more computation comparing the rest of the letters". And your application will say "Incorrect username or password".

But then the attackers try with username `stanleyjobsox` and password `love123`.

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Thu Jan 11 14:33:05 GMT 2024

- 5.9K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/fr/docs/advanced/path-operation-advanced-configuration.md

```

## Description avancée de docstring

Vous pouvez limiter le texte utilisé de la docstring d'une *fonction de chemin* qui sera affiché sur OpenAPI.

L'ajout d'un `\f` (un caractère d'échappement "form feed") va permettre à **FastAPI** de tronquer la sortie utilisée pour OpenAPI à ce stade.

Il n'apparaîtra pas dans la documentation, mais d'autres outils (tel que Sphinx) pourront utiliser le reste.

```Python hl_lines="19-29"

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Thu Apr 18 19:53:19 GMT 2024

- 8K bytes

- Viewed (0)

github.com/tiangolo/fastapi

fastapi/applications.py

            ),
        ] = None,
        deprecated: Annotated[
            Optional[bool],
            Doc(
                """
                Mark all *path operations* as deprecated. You probably don't need it,
                but it's available.

                It will be added to the generated OpenAPI (e.g. visible at `/docs`).

                Read more about it in the

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)

github.com/tiangolo/fastapi

fastapi/openapi/docs.py

    """
    return HTMLResponse(html)


def get_swagger_ui_oauth2_redirect_html() -> HTMLResponse:
    """
    Generate the HTML response with the OAuth2 redirection for Swagger UI.

    You normally don't need to use or change this.
    """
    # copied from https://github.com/swagger-api/swagger-ui/blob/v4.14.0/dist/oauth2-redirect.html
    html = """
    <!doctype html>
    <html lang="en-US">
    <head>

Python

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Tue Apr 02 02:48:51 GMT 2024

- 10.1K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/async.md

---

If you just don't know, use normal `def`.

---

**Note**: You can mix `def` and `async def` in your *path operation functions* as much as you need and define each one using the best option for you. FastAPI will do the right thing with them.

Anyway, in any of the cases above, FastAPI will still work asynchronously and be extremely fast.

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Thu Apr 18 19:53:19 GMT 2024

- 23K bytes

- Viewed (0)

Search Options