sindresorhus / awesome-nodejs

:zap: Delightful Node.js packages and resources
https://node.cool
Creative Commons Zero v1.0 Universal
58.34k stars 5.83k forks source link

Include sonic < express > in documentation section #1137

Closed tiemma closed 3 years ago

tiemma commented 3 years ago

By submitting this pull request, I promise I have read the contribution guidelines twice and ensured my submission follows it. I realize not doing so wastes the maintainers' time that they could have spent making the world better. 🖖

⬆⬆⬆⬆⬆⬆⬆⬆⬆⬆

Link to the package: https://github.com/Tiemma/sonic-express

Reasons for including: It adds support for API documentation on the fly which is not common amongst the Express ecosystem.

It has some similar design considerations to Flask RestX but due to Node's limitation in support for implicitly documenting APIs, this uses tests or gives the user the ability to generate as they work on the APIs themselves (self-documented at the end of the day).

As far as requests hit the API, the middle ware would document them as they go and overwrite subsequent requests based on the status code and other param.

I currently built this and it is used at Replex where I work and over the months, I have on-boarded users who've had similar problems and issued fixes and API updates and they use it too hassle free.

Looking to extend visibility for it as it works really well from the feedback I've gotten and ease of integration from external parties.

sindresorhus commented 3 years ago

Looks like a useful package, but I think this would be a better fit for: https://github.com/rajikaimal/awesome-express I'm trying not to include too many framework-specific packages as there's just so many.