An open API service indexing awesome lists of open source software.

https://github.com/crazyoptimist/swagger-ui-docker

Hands-on swagger-ui deployment using docker-compose
https://github.com/crazyoptimist/swagger-ui-docker

Last synced: 5 months ago
JSON representation

Hands-on swagger-ui deployment using docker-compose

Awesome Lists containing this project

README

          

# Swagger UI Using Docker Compose

## Description
This is hands-on deployment kit for api documentation according to OpenAPI 3 standards

Authored by [CrazyOptimist](https://www.crazyoptimist.net/about)

## How to use
Put your api doc file 'filename.yaml' into the directory 'swagger'

Create .env file using this command:

```shell
cp .env.example .env
```
Open the .env file and feed this: `FILE_URL=swagger/filename.yaml`

Launch the app
```shell
docker-compose up -d
```
Open this url on your machine: `http://localhost:8000`