Getting Started

Installing Restful CLI

Get started with Restful by installing the CLI with the following command:

# install globally
npm install -g modelier-cli

NOTE

We are working on a Go port of Restful CLI. Check back soon for more info.

Project Structure

Restful only requires a single file to operate, known as the spec file.

Spec files are the root of the Restful platform, similar to other API specification protocols such as OpenAPI, API Blueprint, and SDL. Spec files can be used to automatically generate these other types of documents.

For anything more complex than CRUD resources autogenerated by Restful, Custom Endpoints can be used to define and include custom API resources generated into your Restful API.

Spec files and custom endpoints can be either used manually in conjunction with the Restful CLI, or can be generated using the Restful webapp.