Skip to content

Generate zero-dependency HTML documentation for REST API with OpenAPI, ReDoc CLI & Docker Compose. Alternative for Swagger UI.

Notifications You must be signed in to change notification settings

aiiddqd/redoc.docker

Repository files navigation

Redoc App for render HTML Docs from OpenAPI

127.0.0.1 redoc.local

Generate zero-dependency HTML file

  1. Заходим в контейнер и генерим HTML
docker exec -ti npm-app /bin/bash
npx redoc-cli bundle openapi.yaml
  1. проверяем файл в app/redoc-static.html

Example

Example

Makefile commands

  • make up - start app
  • make log - display log from docker
  • make stop
  • make restart

Snippets

php composer setup

docker-compose run php-app composer install

php app shell

docker exec -ti php-app /bin/sh
docker exec -ti php-app /bin/bash

docker exec -ti npm-app /bin/bash

About

Generate zero-dependency HTML documentation for REST API with OpenAPI, ReDoc CLI & Docker Compose. Alternative for Swagger UI.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages