custom - Code Search

docs_src/custom_docs_ui/tutorial001.py

    get_redoc_html,
    get_swagger_ui_html,
    get_swagger_ui_oauth2_redirect_html,
)

app = FastAPI(docs_url=None, redoc_url=None)


@app.get("/docs", include_in_schema=False)
async def custom_swagger_ui_html():
    return get_swagger_ui_html(
        openapi_url=app.openapi_url,
        title=app.title + " - Swagger UI",
        oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url,

Python

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

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

- 1.1K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/custom_docs_ui/tutorial002.py

from fastapi.staticfiles import StaticFiles

app = FastAPI(docs_url=None, redoc_url=None)

app.mount("/static", StaticFiles(directory="static"), name="static")


@app.get("/docs", include_in_schema=False)
async def custom_swagger_ui_html():
    return get_swagger_ui_html(
        openapi_url=app.openapi_url,
        title=app.title + " - Swagger UI",
        oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url,

Python

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

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

- 1.1K bytes

- Viewed (0)

github.com/tiangolo/fastapi

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

We see that we are going to need some dependencies used in several places of the application.

So we put them in their own `dependencies` module (`app/dependencies.py`).

We will now use a simple dependency to read a custom `X-Token` header:

=== "Python 3.9+"

    ```Python hl_lines="3  6-8" title="app/dependencies.py"
    {!> ../../../docs_src/bigger_applications/app_an_py39/dependencies.py!}
    ```

=== "Python 3.8+"

Plain Text

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

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

- 18.6K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/how-to/general.md

To add metadata to your OpenAPI schema, including a license, version, contact, etc, read the docs for [Tutorial - Metadata and Docs URLs](../tutorial/metadata.md){.internal-link target=_blank}.

## OpenAPI Custom URL

To customize the OpenAPI URL (or remove it), read the docs for [Tutorial - Metadata and Docs URLs](../tutorial/metadata.md#openapi-url){.internal-link target=_blank}.

## OpenAPI Docs URLs

Plain Text

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

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

- 2.3K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/mkdocs.yml

      advanced/async-sql-databases.md: how-to/async-sql-encode-databases.md
      advanced/nosql-databases.md: how-to/nosql-databases-couchbase.md
      advanced/graphql.md: how-to/graphql.md
      advanced/custom-request-and-route.md: how-to/custom-request-and-route.md
      advanced/conditional-openapi.md: how-to/conditional-openapi.md
      advanced/extending-openapi.md: how-to/extending-openapi.md
  mkdocstrings:
    handlers:
      python:

Others

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

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

- 9.1K bytes

- Viewed (0)

github.com/tiangolo/fastapi

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

```Python hl_lines="1  4  7-9"
{!../../../docs_src/extending_openapi/tutorial001.py!}
```

### Das OpenAPI-Schema generieren

Verwenden Sie dann dieselbe Hilfsfunktion, um das OpenAPI-Schema innerhalb einer `custom_openapi()`-Funktion zu generieren:

```Python hl_lines="2  15-21"
{!../../../docs_src/extending_openapi/tutorial001.py!}
```

### Das OpenAPI-Schema ändern

Plain Text

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

- Last Modified: Thu Mar 14 16:44:05 GMT 2024

- 3.7K bytes

- Viewed (0)

github.com/tiangolo/fastapi

tests/test_tutorial/test_custom_response/test_tutorial001.py

from fastapi.testclient import TestClient

from docs_src.custom_response.tutorial001 import app

client = TestClient(app)


def test_get_custom_response():
    response = client.get("/items/")
    assert response.status_code == 200, response.text
    assert response.json() == [{"item_id": "Foo"}]


def test_openapi_schema():
    response = client.get("/openapi.json")
    assert response.status_code == 200, response.text

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_tutorial/test_custom_response/test_tutorial001b.py

from fastapi.testclient import TestClient

from docs_src.custom_response.tutorial001b import app

client = TestClient(app)


def test_get_custom_response():
    response = client.get("/items/")
    assert response.status_code == 200, response.text
    assert response.json() == [{"item_id": "Foo"}]


def test_openapi_schema():
    response = client.get("/openapi.json")
    assert response.status_code == 200, response.text

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_tutorial/test_custom_response/test_tutorial004.py

from fastapi.testclient import TestClient

from docs_src.custom_response.tutorial004 import app

client = TestClient(app)


html_contents = """
    <html>
        <head>
            <title>Some HTML in here</title>
        </head>
        <body>
            <h1>Look ma! HTML!</h1>
        </body>
    </html>
    """


def test_get_custom_response():
    response = client.get("/items/")

Python

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

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

- 1.2K bytes

- Viewed (0)

github.com/tiangolo/fastapi

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

But you can also provide other alternative `servers`, for example if you want *the same* docs UI to interact with a staging and production environments.

If you pass a custom list of `servers` and there's a `root_path` (because your API lives behind a proxy), **FastAPI** will insert a "server" with this `root_path` at the beginning of the list.

For example:

```Python hl_lines="4-7"

Plain Text

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

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

- 11.6K bytes

- Viewed (2)

Search Options