Look - Code Search

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

Because it is installed in the local project, you probably wouldn't be able to call that command directly, but you would put it on your `package.json` file.

It could look like this:

```JSON  hl_lines="7"
{
  "name": "frontend-app",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {

Plain Text

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

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

- 10.5K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/tutorial/testing.md

!!! tip
    If you want to call `async` functions in your tests apart from sending requests to your FastAPI application (e.g. asynchronous database functions), have a look at the [Async Tests](../advanced/async-tests.md){.internal-link target=_blank} in the advanced tutorial.

## Separating tests

In a real application, you probably would have your tests in a different file.

Plain Text

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

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

- 6.2K bytes

- Viewed (0)

github.com/tiangolo/fastapi

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

# First Steps

The simplest FastAPI file could look like this:

```Python
{!../../../docs_src/first_steps/tutorial001.py!}
```

Copy that to a file `main.py`.

Run the live server:

<div class="termy">

```console
$ uvicorn main:app --reload

<span style="color: green;">INFO</span>:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
<span style="color: green;">INFO</span>:     Started reloader process [28720]

Plain Text

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

- Last Modified: Fri Jun 30 18:25:16 GMT 2023

- 9.2K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/advanced/behind-a-proxy.md

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:

<img src="/img/tutorial/behind-a-proxy/image03.png">

!!! tip
    The docs UI will interact with the server that you select.

### Disable automatic server from `root_path`

Plain Text

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

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

- 11.6K bytes

- Viewed (2)

github.com/tiangolo/fastapi

docs/en/docs/contributing.md

#### Preview the result

As already mentioned above, you can use the `./scripts/docs.py` with the `live` command to preview the results (or `mkdocs serve`).

Once you are done, you can also test it all as it would look online, including all the other languages.

To do that, first build all the docs:

<div class="termy">

```console
// Use the command "build-all", this will take a bit
$ python ./scripts/docs.py build-all

Plain Text

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

- Last Modified: Thu Jan 11 17:42:43 GMT 2024

- 14.1K 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/alternatives.md

The way you use it is very simple. For example, to do a `GET` request, you would write:

```Python
response = requests.get("http://example.com/some/url")
```

The FastAPI counterpart API *path operation* could look like:

```Python hl_lines="1"
@app.get("/some/url")
def read_url():
    return {"message": "Hello World"}
```

See the similarities in `requests.get(...)` and `@app.get(...)`.

Plain Text

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

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

- 23.2K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/tutorial/middleware.md

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 Apr 28 07:19:10 GMT 2024

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

- 2.9K 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/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