项目作者: uptimizt

项目描述 :
Generate zero-dependency HTML documentation for REST API with OpenAPI, ReDoc CLI & Docker Compose. Alternative for Swagger UI.
高级语言: HTML
项目地址: git://github.com/uptimizt/redoc.docker.git
创建时间: 2020-02-28T06:03:17Z
项目社区:https://github.com/uptimizt/redoc.docker

开源协议:

下载


Redoc App for render HTML Docs from OpenAPI

Generate zero-dependency HTML file

  1. Заходим в контейнер и генерим HTML
    1. docker exec -ti npm-app /bin/bash
    2. npx redoc-cli bundle openapi.yaml
  2. проверяем файл в 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

  1. docker-compose run php-app composer install

php app shell

  1. docker exec -ti php-app /bin/sh
  2. docker exec -ti php-app /bin/bash
  3. docker exec -ti npm-app /bin/bash