https://github.com/reloxx13/ddev-swagger-ui

Swagger UI add-on for DDEV
https://github.com/reloxx13/ddev-swagger-ui

ddev ddev-addon ddev-get ddev-service ddev-swagger-ui developer-tools development docker documentation openapi swagger swagger-ui

Last synced: about 1 month ago
JSON representation

Swagger UI add-on for DDEV

• Host: GitHub
• URL: https://github.com/reloxx13/ddev-swagger-ui
• Owner: reloxx13
• License: apache-2.0
• Created: 2023-09-19T07:15:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-29T13:17:34.000Z (9 months ago)
• Last Synced: 2024-11-11T17:48:23.154Z (3 months ago)
• Topics: ddev, ddev-addon, ddev-get, ddev-service, ddev-swagger-ui, developer-tools, development, docker, documentation, openapi, swagger, swagger-ui
• Language: Shell
• Homepage:
• Size: 85 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![tests](https://github.com/reloxx13/ddev-swagger-ui/actions/workflows/tests.yml/badge.svg)](https://github.com/reloxx13/ddev-swagger-ui/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2024.svg)

## What is ddev-swagger-ui?

This repository provides [Swagger UI](https://swagger.io/tools/swagger-ui/) as a [DDEV](https://ddev.com/) add-on to serve a web-ui for a [OpenAPI/Swagger](https://swagger.io/resources/open-api/) (api documentation) file.

This addon is based on the [Swagger UI Docker Image](https://hub.docker.com/r/swaggerapi/swagger-ui).

Advanced documentation can be found in the [Swagger UI Docker Docs](https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/installation.md#docker).

DDEV docs for [Additional Service Configurations & Add-ons](https://ddev.readthedocs.io/en/latest/users/extend/additional-services/)

## Using ddev-swagger-ui within a project

### Dependencies

Make sure you have [DDEV v1.22.1+ installed](https://ddev.readthedocs.io/en/latest/users/install/ddev-installation/)

### 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=