Skip to content

Configuration

star-openapi provides various configurations that you can use to customize the behavior of the API documentation and UI.

SWAGGER_HTML_STRING⚓︎

You can customize the custom behavior of this template.

You can find the default SWAGGER_HTML_STRING in the star-openapi source code.

SWAGGER_CONFIG⚓︎

You can change the default behavior of the Swagger UI.

1
2
3
4
5
6
7
8
from star_openapi import OpenAPI

app = OpenAPI(info=info)

app.config["SWAGGER_CONFIG"] = {
    "docExpansion": "none",
    "validatorUrl": "https://www.b.com"
}

More configuration options for Swagger UI.

OAUTH_CONFIG⚓︎

You can configure OAuth 2.0 authorization for Swagger UI.

1
2
3
4
5
from star_openapi import OpenAPI

app = OpenAPI(info=info)

app.config["OAUTH_CONFIG"] = {"clientId": "xxx", "clientSecret": "xxx"}

More configuration options for Swagger UI.

SCALAR_HTML_STRING⚓︎

You can customize the custom behavior of this template.

You can find the default SCALAR_HTML_STRING in the star-openapi source code.

SCALAR_CONFIG⚓︎

You can change the default behavior of the Scalar UI.

More configuration options for Swagger UI.

REDOC_HTML_STRING⚓︎

You can customize the custom behavior of this template.

You can find the default REDOC_HTML_STRING in the star-openapi source code.

REDOC_CONFIG⚓︎

You can change the default behavior of the Redoc UI.

More configuration options for Redoc UI.

RAPIDOC_HTML_STRING⚓︎

You can customize the custom behavior of this template.

You can find the default RAPIDOC_HTML_STRING in the star-openapi source code.

RAPIDOC_CONFIG⚓︎

You can change the default behavior of the Rapidoc UI.

More configuration options for Rapidoc UI.

RAPIPDF_HTML_STRING⚓︎

You can customize the custom behavior of this template.

You can find the default RAPIPDF_HTML_STRING in the star-openapi source code.

RAPIPDF_CONFIG⚓︎

You can change the default behavior of the Rapipdf UI.

More configuration options for Rapipdf UI.

ELEMENTS_HTML_STRING⚓︎

You can customize the custom behavior of this template.

You can find the default ELEMENTS_HTML_STRING in the star-openapi source code.

ELEMENTS_CONFIG⚓︎

You can change the default behavior of the Elements UI.

More configuration options for Rapipdf UI.