/yapidoc

a doc server for Yapi

Primary LanguageGoMIT LicenseMIT

yapidoc

yapidoc is a doc server for YMFE/Yapi .

Usage

  1. run a yapidoc server using docker
docker run -itd --name yapidoc -e YAPI_URL=your_yapi_url -p 8888:8888 futuretea/yapidoc
  1. download doc from the yapidoc server
http://127.0.0.1:8888/projects/your_project_token
http://127.0.0.1:8888/projects/your_project_token?format=json&tag=your_api_tag
http://127.0.0.1:8888/projects/your_project_token?format=markdown&tag=your_api_tag
  1. stop the yapidoc server
docker stop yapidoc
docker rm yapidoc

Documentation

Related Projects

License

This project is released under the terms of the MIT license.