Skip to content
HiMarket 开源,打造开箱即用的 AI 开放平台Know more

Enable Swagger UI of Console

Enable Swagger UI of Higress Console

K8s Deployment

Add --set higress-console.swagger.enabled=true arguments to the helm install or upgrade command.

Docker Compose Deployment

Add the following lines into compose/console.env file in the installation directory and restart Higress.

Terminal window
SPRINGDOC_API_DOCS_ENABLED=true
SPRINGDOC_SWAGGER_UI_ENABLED=true

all-in-one Image deployment

Add -e SPRINGDOC_API_DOCS_ENABLED=true -e SPRINGDOC_SWAGGER_UI_ENABLED=true arguments to the docker run command.

Swagger UI URL

http://<higress-console-endpoint>/swagger-ui/index.html