blazing-edge-labs / api-skeleton

3 stars 1 forks source link

Automatic API documentation #12

Open iblazevic opened 5 years ago

iblazevic commented 5 years ago

Look into introducing automatic API documentation to skeleton. Without making it easier we are never going to write the documentation ourselves.

Since we already explicitly define all allowed body properties seems like we have the foundation to do it.

rkatic commented 5 years ago

A perhaps valuable option is to try to extract docs from our Joi based validations using Joi.describe(schema). Otherwise, if we opt for something like Swagger, my only concern is how to still have complex validations that we have with Joi.