Часто мы тратим много времени, пытаясь проверить полезную нагрузку внутри нашей логики, что делает наш код громоздким, трудным для чтения, а иногда мы даже забываем, что определенные варианты использования делают нашу проверку безуспешной. Есть еще один подход, который мы можем использовать, и это использовать некоторый валидатор схемы JSON, но все же они не читаются, и мы должны написать много строк кода.
Для этого подхода я использовал валидатор Joi от hapi, который можно найти здесь: https://github.com/hapijs/joi
Синтаксис этого пакета очень чистый и читаемый. После проверки полезной нагрузки мы будем использовать ту же схему от Joi для создания документации.
Существует множество различных библиотек, которые используются для создания документации по API, но мое внимание привлекла Swagger. Я пошел по этому пути с Swagger, потому что у него хорошая документация, он интерактивен, и вы можете отправлять разные запросы из документации. Вы также можете программно создавать документацию с пакетами Swagger npm.
Подробнее о pkg и о том, как его использовать в этом репо: