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 May 05 07:19:11 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 May 05 07:19:11 GMT 2024

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

- 1.8K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/advanced/openapi-callbacks.md

This code won't be executed in your app, we only need it to *document* how that *external API* should look like.

But, you already know how to easily create automatic documentation for an API with **FastAPI**.

So we are going to use that same knowledge to document how the *external API* should look like... by creating the *path operation(s)* that the external API should implement (the ones your API will call).

!!! tip

Plain Text

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

- Last Modified: Thu May 02 22:37:31 GMT 2024

- 7.7K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/response_model/tutorial003_04_py310.py

from fastapi import FastAPI, Response
from fastapi.responses import RedirectResponse

app = FastAPI()


@app.get("/portal")
async def get_portal(teleport: bool = False) -> Response | dict:
    if teleport:
        return RedirectResponse(url="https://www.youtube.com/watch?v=dQw4w9WgXcQ")

Python

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

- Last Modified: Tue Jan 10 16:22:47 GMT 2023

- 352 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/response_model/tutorial003_02.py

from fastapi import FastAPI, Response
from fastapi.responses import JSONResponse, RedirectResponse

app = FastAPI()


@app.get("/portal")
async def get_portal(teleport: bool = False) -> Response:
    if teleport:
        return RedirectResponse(url="https://www.youtube.com/watch?v=dQw4w9WgXcQ")

Python

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

- Last Modified: Tue Jan 10 16:22:47 GMT 2023

- 381 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/custom_response/tutorial002.py


@app.get("/items/", response_class=HTMLResponse)
async def read_items():
    return """
    <html>
        <head>
            <title>Some HTML in here</title>
        </head>
        <body>
            <h1>Look ma! HTML!</h1>
        </body>
    </html>

Python

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

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

- 352 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/response_model/tutorial003_05.py

from typing import Union

from fastapi import FastAPI, Response
from fastapi.responses import RedirectResponse

app = FastAPI()


@app.get("/portal", response_model=None)
async def get_portal(teleport: bool = False) -> Union[Response, dict]:
    if teleport:
        return RedirectResponse(url="https://www.youtube.com/watch?v=dQw4w9WgXcQ")

Python

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

- Last Modified: Tue Jan 10 16:22:47 GMT 2023

- 405 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/query_params/tutorial003.py

from typing import Union

from fastapi import FastAPI

app = FastAPI()


@app.get("/items/{item_id}")
async def read_item(item_id: str, q: Union[str, None] = None, short: bool = False):
    item = {"item_id": item_id}
    if q:
        item.update({"q": q})
    if not short:
        item.update(
            {"description": "This is an amazing item that has a long description"}
        )

Python

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

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

- 406 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/query_params/tutorial004_py310.py

from fastapi import FastAPI

app = FastAPI()


@app.get("/users/{user_id}/items/{item_id}")
async def read_user_item(
    user_id: int, item_id: str, q: str | None = None, short: bool = False
):
    item = {"item_id": item_id, "owner_id": user_id}
    if q:
        item.update({"q": q})
    if not short:
        item.update(
            {"description": "This is an amazing item that has a long description"}
        )

Python

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

- Last Modified: Fri Jan 07 14:11:31 GMT 2022

- 436 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/security/tutorial002_an_py310.py

app = FastAPI()

oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")


class User(BaseModel):
    username: str
    email: str | None = None
    full_name: str | None = None
    disabled: bool | None = None


def fake_decode_token(token):
    return User(
        username=token + "fakedecoded", email="******@****.***", full_name="John Doe"
    )

Python

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

- Last Modified: Sat Mar 18 12:29:59 GMT 2023

- 761 bytes

- Viewed (0)

Search Options