search

thecasualcoder / dobby

dobby is free and will serve your orders
Apache License 2.0
32 stars 25 forks source link

Add Swagger docs #10

Closed arunvelsriram closed 4 years ago

arunvelsriram commented 4 years ago
  1. Add swagger docs for all routes except
    • /proxy (not sure how to use it)
    • /call
  2. Updated go to 1.14

I deployed the Swagger UI in Heroku to give a feel of how it looks like. Its available here: https://thecasualcoder-dobby.herokuapp.com/swagger/index.html. Be cautious of executing APIs that can crash dobby (crash, turbo etc.) as there is a a cool-off period in Heroku for recovering from crash.

We can later decide if we need this to be deployed somewhere.

jskswamy commented 4 years ago

@arunvelsriram will update readme.md on how to use the /proxy endpoint