swagger-jsdoc VS emailengine

For this task, we are going to use swagger-jscode. It says that it is to write Swagger, old name of OpenAPI, inside jsdoc, like below

js doc style comments support

There's swagger-ui-express which can work with swagger-jsdoc.

If so, how do you go about generating the interface files? I recently discovered swaggo which generates OpenAPI docs from Go annotations. My Googlefoo then led me to swagger-jsdoc and openapi-comment-parser which do the same thing from JSdoc-like comments. Do you use them, do you use some other module, or do you use some other approach entirely?

Express by itself lacks a lot of metadata useful for generating OpenAPI spec, you'll end up writing a lot of non-standard doc comments. You want to use something like swagger-jsdoc to generate the spec and then some other package to generate the UI.

This article is a continuation of a series about how to build a REST API in Node.js. In the preceding article of this series we added request and response validation that is based on an OpenAPI spec of the API. We used the swagger-jsdoc package to generate this OpenAPI spec from comments in our code that annotate the REST operations.

The swagger-jsdoc package enables us to do this. It looks for JSDoc comments in code (annotated with an @openapi tag) to generate the OpenAPI specification.

When I started with https://emailengine.app, a similar product, I also considered releasing it as a SaaS. But looking at the competition, it seemed too complicated for me (just look at the compliance list for Nylas Email API https://www.nylas.com/security/#compliance ). Will be interesting to see how it works out for you. Good luck!

EmailEngine has all the code public [1], even though it is not open-source but is source-available. Some core parts I even published under the MIT license, like the IMAP client library I built from scratch to serve the special requirements EmailEngine has for IMAP access [2]

My thinking has always been that those who try to hack the license validation stuff and replace the missing build pipeline were never going to be my customers in the first place, so every second I would spend on them is a wasted effort.

[1] https://github.com/postalsys/emailengine

https://github.com/postalsys/emailengine

Seems open-source to me.

Well, I for one, hope that email stays as complicated as described in the post. Otherwise my project that simplifies access to email accounts (https://emailengine.app) would get no traction :D

I'd like to know if anyone here can share some experience using https://emailengine.app in a larger environment, e.g. managing / watching 100-200 email accounts and processing ~50.000-100.000 mails per day?

I had the same issues when I started with https://emailengine.app - just like Ghost, it’s an app written in Nodejs. I tried multiple distribution options at first and finally went with complete self containment. All modules are pre-installed during the publishing step and thus the user never needs to run npm. Or if you download the “compiled” single binary version you don’t even need node as it’s bundled with the binary (I use the pkg module to bundle these executables). So upgrading is just downloading and replacing the old version files with new ones.

The dowside - no sane way to use compiled dependencies, everything has to be vanilla javascript.