Add swagger documentation to API

goldbergyoni / node-chaos-monkey

Extremly naughty chaos monkey for Node.js

MIT License

228 stars 10 forks source link

Add swagger documentation to API #14

Open goldbergyoni opened 5 years ago

goldbergyoni commented 5 years ago

Why: allow the API clients skim through standard and structured docs and also test the API

How: add a route that returns a swagger UI webpage where the user can skim through our API routes. There are couple of packages that can facilitate this, feel free to consult about the implementation