steph-koopmanschap / easy-API-documentation-template

An easy way to create documentation for your API with HTML

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

API Documentation with HTML

Open index.html and you can see an overview of all your API routes and what they do. The default file is just a template and an example.

How to make your own documentation

Simply edit the index.html file and fill in the information You can copy paste the routes to add your own. To do so copy everything between <!-- PATH --> and <!-- PATH -END --> For complete customization you can also edit the index.css file, but in general its not needed to be touched.

Screenshots

api documentation screenshot

About

An easy way to create documentation for your API with HTML

License:MIT License


Languages

Language:HTML 92.3%Language:CSS 7.7%