Skip to content

noonat/yup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published