ferryjs/ferry

Ferry is (yet another) REST API framework.

ferry's Issues

Installation, usage and development documentation

Change "Adapter" terminology

We should just be more clear here, as adapter is too vague a word.

Output formatters: serializers (and transformers maybe)

One other layer we should think about is output formats. There are quite a few primary ones: JSON API, JSON HAL, JSON-LD, etc.

There's also possibly transformers, though this is less likely necessary in our case, and might be mitigated by hooks in resource handlers (though I could see using the default handlers, and just tweaking the format slightly). One source of inspiration here is Fractal.

Specification standard

There should be a default specification for defining RESTful routes and models. Adapters would then be responsible for adhering to the standard.

Something that defined the following could be a good simple starting off point.

name
version
basePath
resource
 - routes
 - model

It may be worth looking at JSONSchema or YAML to use as a base potentially

Ferry class test coverage

ORM agnostic?

it may make sense to explore the possibility of decoupling Waterline. Will this provide value? What are the other viable candidates.

Contribution guidelines

Code level documentation standard

JSDoc?

Add version awareness to Specification

NPM release features

We should start a list of features necessary to do a proper release in npm.

Load and merge multiple Specification source files

Override resource handlers

There should be a way to override the default generated handlers. You should be able to house the resource files in a directory that is discoverable or configurable.

Router class test coverage

Break components into separate modules

I think we may want to break the individual components into separate modules. This way when building user land extensions, we can extend the existing classes. In order to do this now, we would need to pull down the main library, which may prove expensive as this project matures.

Move examples into ferryjs/ferry-examples repository

Just to clean the main repository up a bit, and make development a little smoother.

Add ORM middleware per resource