search

cfpb / pantheon

:warning: THIS PROJECT IS DEPRECATED :warning:
Creative Commons Zero v1.0 Universal
3 stars 10 forks source link

tech decision: node api framework #49

Open dgreisen-cfpb opened 9 years ago

dgreisen-cfpb commented 9 years ago

We need to decide on a node api framework.

requirements:

  1. easy to use
  2. clear and concise
  3. self documenting

Currently we are using express, which meets (1), kinda meets (2), but fails (3).

@m3brown @contolini @imuchnik @sephcoster: thoughts?

sephcoster commented 9 years ago

The only one outside of vanilla Express that I've used is Loopback. It's self documenting using Swagger + some other sugar, and has a bunch of built-in command line generators that make it pretty easy to use (also a GUI available that just went into Beta). Loopback runs on top of Express so it would bolt on pretty easily. That said, maybe just bolting something like Swagger on to our existing API could work as well?

Additionally, there is also Restify - it was built as an alternative to building an API with express from what I've read of the docs, but I haven't had the opportunity to use it in anger. I would take a look at the docs to see if their use case matches up with our own.

dgreisen-cfpb commented 9 years ago

Thanks Seph. I just took a dive into loopback. It looks fun, but It has a bit too much magic for my taste.

I was looking at restify, but it has some apparently significant performance issues. Which doesn't make a whole lot of sense. I guess we will just continue to use express.