Swagger validation, TLS/SSL, and Logging

richardzyx commented 6 years ago

I'm committing changes by comparing files diffs against my project folder, so if I missed anything obvious, please feel free to let me know.

Swagger is implemented with hapi-swagger. I think I have tagged all the endpoints and added some missing validations, but definitely feel free to let me know if I missed anything. Go to /documentation to use Swagger.
TLS/SSL support. As @jedireza probably remembered, I spent quite some time poking around this issue. Given the bug in confidence and current structure, I believe this is somewhat of an optimal solution.
Basic hapi logging. I read some of the past issues and understand it's a controversial topic. I've only included it here so you can choose if it can stay.
Misc.: git ignore file; added examples on how to customize Swagger with notes, description, and response validation & documentation; package-lock.json is checked out for clear PR review

With Swagger validation & documentation on both the input and response, implementing new APIs and documentation have truly been a breeze with very readable code. I also found that the same schema based thinking also ties together with mongo-models so I've found it to be quite useful so far. I usually have failAction under both validation and response as a basic template.

I'm using pm2 and pm2 ecosystem file instead of dotenv. I don't believe it's a common use case, but if there are interests in future I can post those up as well.

Thanks!

richardzyx commented 6 years ago

I was also hoping to work on integrating Joi's latest feature in v11 with isoDate and isemail, but we will see...

jedireza commented 6 years ago

Thanks for opening a PR! There's more than just a hapi-swagger implementation here though. Let's create a PR just for Swagger and see how that looks.

TLS/SSL support
Basic hapi logging
Misc.

We didn't discuss these things in #174 and they should be their own issues/PRs anyways. I'm closing this PR for now. Feel free to open a new PR with just the changes needed to replace lout with hapi-swagger.

jedireza / frame

Swagger validation, TLS/SSL, and Logging #175