0.0.1 • Published 8 years ago

rest-api-doc-gui v0.0.1

Weekly downloads
3
License
MIT
Repository
github
Last release
8 years ago

rest-api-doc-gui

A GUI for creating documentation for REST APIs. Electron + Angular App

Details

  • This is a simple GUI Written in Electron+Angular, Which will will save Each ApiDocs entries to a HJSON - Human-readable JSON .
  • The GUI is only targetting API documentation. So it designed for that.
  • All the 'description' feilds are Markdown enabled.
  • We can see the live (A kind of) preview on the GUI it self.
  • In the server, we can use this Cli tool to render the HJSON file to a Single HTML page