Book - Code Search

docs/en/docs/learn/index.md

# Learn

Here are the introductory sections and the tutorials to learn **FastAPI**.

Plain Text

- Registered: Sun Apr 28 07:19:10 GMT 2024

- Last Modified: Wed Oct 18 12:36:40 GMT 2023

- 195 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/advanced/index.md

## External Courses

Although the [Tutorial - User Guide](../tutorial/index.md){.internal-link target=_blank} and this **Advanced User Guide** are written as a guided tutorial (like a book) and should be enough for you to **learn FastAPI**, you might want to complement it with additional courses.

Or it might be the case that you just prefer to take other courses because they adapt better to your learning style.

Plain Text

- Registered: Sun Apr 28 07:19:10 GMT 2024

- Last Modified: Sun Mar 31 23:52:53 GMT 2024

- 1.8K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/custom_response/tutorial004.py

app = FastAPI()


def generate_html_response():
    html_content = """
    <html>
        <head>
            <title>Some HTML in here</title>
        </head>
        <body>
            <h1>Look ma! HTML!</h1>
        </body>
    </html>
    """
    return HTMLResponse(content=html_content, status_code=200)


@app.get("/items/", response_class=HTMLResponse)
async def read_items():

Python

- Registered: Sun Apr 28 07:19:10 GMT 2024

- Last Modified: Thu Mar 26 19:09:53 GMT 2020

- 491 bytes

- Viewed (0)

github.com/tiangolo/fastapi

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

{!../../../docs_src/custom_request_and_route/tutorial003.py!}
```

In this example, the *path operations* under the `router` will use the custom `TimedRoute` class, and will have an extra `X-Response-Time` header in the response with the time it took to generate the response:

```Python hl_lines="13-20"
{!../../../docs_src/custom_request_and_route/tutorial003.py!}

Plain Text

- Registered: Sun Apr 28 07:19:10 GMT 2024

- Last Modified: Sun Mar 31 23:52:53 GMT 2024

- 4.4K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/tutorial/metadata.md

{!../../../docs_src/metadata/tutorial001.py!}
```

!!! tip
    You can write Markdown in the `description` field and it will be rendered in the output.

With this configuration, the automatic API docs would look like:

<img src="/img/tutorial/metadata/image01.png">

## License identifier

Since OpenAPI 3.1.0 and FastAPI 0.99.0, you can also set the `license_info` with an `identifier` instead of a `url`.

For example:

Plain Text

- Registered: Sun Apr 28 07:19:10 GMT 2024

- Last Modified: Sun Mar 31 23:52:53 GMT 2024

- 5.8K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/tutorial/security/first-steps.md

    All the security utilities that integrate with OpenAPI (and the automatic API docs) inherit from `SecurityBase`, that's how **FastAPI** can know how to integrate them in OpenAPI.

## What it does

It will go and look in the request for that `Authorization` header, check if the value is `Bearer ` plus some token, and will return the token as a `str`.

Plain Text

- Registered: Sun Apr 28 07:19:10 GMT 2024

- Last Modified: Wed Mar 13 19:02:19 GMT 2024

- 8.9K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/deployment/https.md

The idea is to automate the acquisition and renewal of these certificates so that you can have **secure HTTPS, for free, forever**.

## HTTPS for Developers

Here's an example of how an HTTPS API could look like, step by step, paying attention mainly to the ideas important for developers.

### Domain Name

Plain Text

- Registered: Sun Apr 28 07:19:10 GMT 2024

- Last Modified: Thu Jan 11 16:31:18 GMT 2024

- 12K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/tutorial/bigger-applications.md

The section:

```Python
from .routers import items, users
```

means:

* Starting in the same package that this module (the file `app/main.py`) lives in (the directory `app/`)...
* look for the subpackage `routers` (the directory at `app/routers/`)...
* and from it, import the submodule `items` (the file at `app/routers/items.py`) and `users` (the file at `app/routers/users.py`)...

Plain Text

- Registered: Sun Apr 28 07:19:10 GMT 2024

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

- 18.6K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/release-notes.md

* 🔧 Add `CITATION.cff` file for academic citations. PR [#10496](https://github.com/tiangolo/fastapi/pull/10496) by [@tiangolo](https://github.com/tiangolo).
* 🐛 Fix overriding MKDocs theme lang in hook. PR [#10490](https://github.com/tiangolo/fastapi/pull/10490) by [@tiangolo](https://github.com/tiangolo).

Plain Text

- Registered: Sun Apr 28 07:19:10 GMT 2024

- Last Modified: Sun Apr 28 00:28:00 GMT 2024

- 385.5K bytes

- Viewed (1)

github.com/tiangolo/fastapi

docs/en/docs/how-to/custom-docs-ui-assets.md

Let's say your project file structure looks like this:

```
.
├── app
│   ├── __init__.py
│   ├── main.py
```

Now create a directory to store those static files.

Your new file structure could look like this:

```
.
├── app
│   ├── __init__.py
│   ├── main.py
└── static/
```

### Download the files

Download the static files needed for the docs and put them on that `static/` directory.

Plain Text

- Registered: Sun Apr 28 07:19:10 GMT 2024

- Last Modified: Mon Oct 30 09:58:58 GMT 2023

- 7.5K bytes

- Viewed (0)

Search Options