Skip to content

Latest commit

 

History

History
74 lines (44 loc) · 1.9 KB

README.md

File metadata and controls

74 lines (44 loc) · 1.9 KB
Raw

While I am happy with many of the ideas in this project, I'm investigating simpler approaches. More to come in the future.

The Roads-API framework

Roads-API is a framework for easily building REST APIs.

Why should I use Roads-API?

  1. Roads-API makes it incredibly easy to build a REST API without having to learn all the details about REST APIs.
  2. Roads-API focuses on being standards compliant, and cleanly, automatically supporting as many standards as possible, so your clients can use the features they need
  3. Roads-API focuses foremost on providing an easy onboarding experience for new API builders. The pattern we have employed gives you clear, well defined locations for all of your business logic, and we handle the rest.

What do you mean by REST?

The term REST has taken on many different meanings, so let's break down what it means for this framework.

  1. We follow the constraints specified in Fielding's dissertation
  2. We attempt to support as many web RFCs as possible (specifically those that apply to APIs)
  3. If we can not by default support an RFC, we will attempt to provide is as an optional add on

Build Status

Index

Getting Started

  1. Create your Resource

  2. Create your Representation

  3. Attach your Representation to your Resource

  4. Define your Resource Actions

  5. Attach your Resource to the Router

Supported Specs

Name RFC How to use 
     |          |

Resource

Response

Router

Representation

JSONRepresentation

HTTPErrors

Constants

TODO:

  • Finish the docs
  • JSON Hyper-Schema init system
  • Easy Hypermedia controls
  • Simpler JSON representation
  • Better JSON schema parsing