{"repo":"twskj/pretty-swag","free":true,"listed":false,"github":"https://github.com/twskj/pretty-swag","clone":"git clone https://github.com/twskj/pretty-swag.git","description":"Pretty UI for Swagger spec","language":"JavaScript","stars":120,"topics":["swagger","documentation-generator","single-page-applications","rest-api","material-design","swagger-ui","api-documentation"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"pretty-swag pretty-swag is a UI for Swagger Specification V2. It is inspired by Swagger Editor. An example of the generated html from petstore spec can be found here Bugs filing and suggestions are always welcome. Changelog See CHANGELOG Requirement Node js Installation Usage API Usage Syntax prettySwag.run(input,output,config,callback); API Example When dst equals null , no file will be written and the html will be returned as second parameter. Command switch Switch Name Optional Description -------------- --------------- -------- ------------------------------------------------------------------------------------------ -i input No Location of a Swagger spec file(can be JSON or YAML) -o output Yes Location of generated document(s). Default to doc.html -f format Yes Format of the output ( singlefile , offline , lite , noicon ). Default to singlefile -m markdown Yes Render Summary & Description as markdown. true or false . Default to false -th theme Yes One of the supported colors or pre-defined theme default -c config Yes Location of a configuration file -fixedNav fixedNav Yes Include this flag to fixed the navigation bar on screen -autoTags autoTags Yes Include this flag to turn on/off automatically generate tags by path and method name -noDate noDate Yes Include this flag to remove generated date -noCredit noCredit Yes Include this flag to remove credit -noNav noNav Yes Include this flag to remove navigation bar. Default to false -noReq noRequest Yes Include this flag to re","default_branch":null,"files":null,"tree":[],"storefront":"/r/twskj","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/twskj/pretty-swag/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}