/api-documentation-template

minimal markdown to document our apis or micreservices

MIT LicenseMIT

Api Endpoint Documentation Template

If swagger, apidocs or another rest api document generator is not an option for you, you can use this light template.

This template cover all the required and common microservice/api endpoint parts.

Versions

Portal

You can use this template to document all your endpoints of all your apis or microservices. If you want a web portal, you just need to order them in folder and use one of these framework which convert your markdown files to a static site