README.md

What is ddev-swagger-ui?

This repository provides Swagger UI as a DDEV add-on to serve a web-ui for a OpenAPI/Swagger (api documentation) file.

This addon is based on the Swagger UI Docker Image.

Advanced documentation can be found in the Swagger UI Docker Docs.

DDEV docs for Additional Service Configurations & Add-ons

Using ddev-swagger-ui within a project

Dependencies

Make sure you have DDEV v1.22.1+ installed

Install

1. cd into your project directory
2. Run ddev config and answer the questions as appropriate
3. Run ddev get reloxx13/ddev-swagger-ui and answer the questions as appropriate
4. Run ddev start or ddev restart

Upgrade

To upgrade your version of ddev-swagger-ui, repeat the ddev get reloxx13/ddev-swagger-ui to get the latest release. To see the installed version, ddev get --installed.

Notes

What does it do right now?

• Provides the following swagger-ui-docker-provided environmental variables:
  • PORT=8080
  • BASE_URL=/
  • SWAGGER_JSON=/var/www/html/swagger.json
  • SWAGGER_JSON_URL=