html - Code Search

fastapi/openapi/docs.py

    })"""

    if init_oauth:
        html += f"""
        ui.initOAuth({json.dumps(jsonable_encoder(init_oauth))})
        """

    html += """
    </script>
    </body>
    </html>
    """
    return HTMLResponse(html)


def get_redoc_html(
    *,
    openapi_url: Annotated[
        str,
        Doc(
            """
            The OpenAPI URL that ReDoc should load and use.

Python

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

- Last Modified: Tue Apr 02 02:48:51 GMT 2024

- 10.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

tests/test_tutorial/test_custom_docs_ui/test_tutorial002.py

        yield client
    static_dir.rmdir()


def test_swagger_ui_html(client: TestClient):
    response = client.get("/docs")
    assert response.status_code == 200, response.text
    assert "/static/swagger-ui-bundle.js" in response.text
    assert "/static/swagger-ui.css" in response.text


def test_swagger_ui_oauth2_redirect_html(client: TestClient):
    response = client.get("/docs/oauth2-redirect")

Python

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

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

- 1.2K bytes

- Viewed (0)

github.com/tiangolo/fastapi

tests/test_tutorial/test_custom_docs_ui/test_tutorial001.py

    static_dir.rmdir()


def test_swagger_ui_html(client: TestClient):
    response = client.get("/docs")
    assert response.status_code == 200, response.text
    assert (
        "https://unpkg.com/swagger-ui-dist@5.9.0/swagger-ui-bundle.js" in response.text
    )
    assert "https://unpkg.com/swagger-ui-dist@5.9.0/swagger-ui.css" in response.text


def test_swagger_ui_oauth2_redirect_html(client: TestClient):

Python

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

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

- 1.3K bytes

- Viewed (0)

github.com/tiangolo/fastapi

fastapi/responses.py


class UJSONResponse(JSONResponse):
    """
    JSON response using the high-performance ujson library to serialize data to JSON.

    Read more about it in the
    [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/).
    """

    def render(self, content: Any) -> bytes:
        assert ujson is not None, "ujson must be installed to use UJSONResponse"

Python

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

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

- 1.7K bytes

- Viewed (0)

github.com/tiangolo/fastapi

fastapi/openapi/models.py

    # Ref: JSON Schema Validation 2020-12: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-vocabularies-for-semantic-c
    # Vocabularies for Semantic Content With "format"
    format: Optional[str] = None
    # Ref: JSON Schema Validation 2020-12: https://json-schema.org/draft/2020-12/json-schema-validation.html#name-a-vocabulary-for-the-conten
    # A Vocabulary for the Contents of String-Encoded Data

Python

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

- Last Modified: Thu Apr 18 22:49:33 GMT 2024

- 15K bytes

- Viewed (1)

github.com/tiangolo/fastapi

docs_src/custom_docs_ui/tutorial002.py

from fastapi.openapi.docs import (
    get_redoc_html,
    get_swagger_ui_html,
    get_swagger_ui_oauth2_redirect_html,
)
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,

Python

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

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

- 1.1K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/custom_docs_ui/tutorial001.py

from fastapi import FastAPI
from fastapi.openapi.docs import (
    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",

Python

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

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

- 1.1K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/metadata/tutorial001.py

        "url": "http://x-force.example.com/contact/",
        "email": "******@****.***",
    },
    license_info={
        "name": "Apache 2.0",
        "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
    },
)


@app.get("/items/")
async def read_items():

Python

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

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

- 805 bytes

- Viewed (0)

github.com/tiangolo/fastapi

fastapi/applications.py

)
from fastapi.exceptions import RequestValidationError, WebSocketRequestValidationError
from fastapi.logger import logger
from fastapi.openapi.docs import (
    get_redoc_html,
    get_swagger_ui_html,
    get_swagger_ui_oauth2_redirect_html,
)
from fastapi.openapi.utils import get_openapi
from fastapi.params import Depends
from fastapi.types import DecoratedCallable, IncEx
from fastapi.utils import generate_unique_id

Python

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

- Last Modified: Tue Apr 02 02:48:51 GMT 2024

- 172.2K bytes

- Viewed (0)

Search Options