https://github.com/noonat/yup

https://github.com/noonat/yup

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/noonat/yup
• Owner: noonat
• License: mit
• Created: 2013-12-19T18:17:48.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2014-01-24T22:56:49.000Z (over 10 years ago)
• Last Synced: 2024-09-06T06:50:54.336Z (27 days ago)
• Language: Python
• Size: 398 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# yup

yup generates HTML documentation for your REST API from YAML files. It will

perform HTTP requests against the API endpoint to validate that your examples

work, and to capture example responses for the documentation.

Installation:

    pip install yup

Usage:

    yup --input-dir DIR --output-dir DIR --url http://127.0.0.1

Options:

- `input-dir` is the directory to read YAML files from.

- `output-dir` is the directoy to write HTML files into.

- `url` is the base URL to use for example requests.