Home - Code Search

docs/pt/docs/tutorial/query-params-str-validations.md

## Apelidos (alias) de parâmetros

Imagine que você queira que um parâmetro tenha o nome `item-query`.

Desta maneira:

```
http://127.0.0.1:8000/items/?item-query=foobaritems
```

Mas o nome `item-query` não é um nome de váriavel válido no Python.

O que mais se aproxima é `item_query`.

Mas ainda você precisa que o nome seja exatamente `item-query`...

Plain Text

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

- Last Modified: Sat May 14 11:59:59 GMT 2022

- 9.3K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/path_operation_advanced_configuration/tutorial001.py

from fastapi import FastAPI

app = FastAPI()


@app.get("/items/", operation_id="some_specific_id_you_define")
async def read_items():

Python

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

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

- 167 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/custom_response/tutorial004.py

from fastapi import FastAPI
from fastapi.responses import HTMLResponse

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)

Python

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

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

- 491 bytes

- Viewed (0)

github.com/tiangolo/fastapi

tests/test_tutorial/test_path_operation_advanced_configurations/test_tutorial001.py

                            "content": {"application/json": {"schema": {}}},
                        }
                    },
                    "summary": "Read Items",
                    "operationId": "some_specific_id_you_define",
                }
            }
        },

Python

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

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

- 1K bytes

- Viewed (0)

github.com/tiangolo/fastapi

tests/test_starlette_exception.py

@app.get("/items/{item_id}")
async def read_item(item_id: str):
    if item_id not in items:
        raise HTTPException(
            status_code=404,
            detail="Item not found",
            headers={"X-Error": "Some custom header"},
        )
    return {"item": items[item_id]}


@app.get("/http-no-body-statuscode-exception")
async def no_body_status_code_exception():
    raise HTTPException(status_code=204)

Python

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

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

- 7.4K bytes

- Viewed (0)

github.com/tiangolo/fastapi

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

# Custom Request and APIRoute class

In some cases, you may want to override the logic used by the `Request` and `APIRoute` classes.

In particular, this may be a good alternative to logic in a middleware.

For example, if you want to read or manipulate the request body before it is processed by your application.

!!! danger
    This is an "advanced" feature.

    If you are just starting with **FastAPI** you might want to skip this section.

Plain Text

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

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

- 4.4K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/openapi_callbacks/tutorial001.py

@app.post("/invoices/", callbacks=invoices_callback_router.routes)
def create_invoice(invoice: Invoice, callback_url: Union[HttpUrl, None] = None):
    """
    Create an invoice.

    This will (let's imagine) let the API user (some external developer) create an
    invoice.

    And this path operation will:

    * Send the invoice to the client.
    * Collect the money from the client.

Python

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

- Last Modified: Sat May 14 11:59:59 GMT 2022

- 1.3K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/tutorial/dependencies/global-dependencies.md

# Global Dependencies

For some types of applications you might want to add dependencies to the whole application.

Similar to the way you can [add `dependencies` to the *path operation decorators*](dependencies-in-path-operation-decorators.md){.internal-link target=_blank}, you can add them to the `FastAPI` application.

In that case, they will be applied to all the *path operations* in the application:

=== "Python 3.9+"

    ```Python hl_lines="16"

Plain Text

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

- Last Modified: Tue Oct 17 05:59:11 GMT 2023

- 1.4K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/how-to/async-sql-encode-databases.md

### About `{**note.dict(), "id": last_record_id}`

`note` is a Pydantic `Note` object.

`note.dict()` returns a `dict` with its data, something like:

```Python
{
    "text": "Some note",
    "completed": False,
}
```

but it doesn't have the `id` field.

So we create a new `dict`, that contains the key-value pairs from `note.dict()` with:

```Python
{**note.dict()}
```

Plain Text

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

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

- 5.3K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/how-to/nosql-databases-couchbase.md

So, if the `dict` contains:

```Python
{
    "username": "johndoe",
    "hashed_password": "some_hash",
}
```

It will be passed to `UserInDB` as:

```Python
UserInDB(username="johndoe", hashed_password="some_hash")
```

## Create your **FastAPI** code

### Create the `FastAPI` app

```Python hl_lines="46"

Plain Text

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

- Last Modified: Tue Jan 16 13:23:25 GMT 2024

- 6K bytes

- Viewed (0)

Search Options