giuseppemp / yaras

YARAS provides standards, guidelines and conventions for writing RESTful APIs and is intended to encourage consistency, maintainability, and consistent use of best practices.

Yet Another RESTful API Standard (YARAS) - Introduction

YARAS provides standards, guidelines and conventions for writing a RESTful API and is intended to encourage consistency, maintainability, and consistent use of best practices.

Table of Contents

• Introduction
• Build
• Create a PDF version
• Create an HTML version

Introduction

YARAS is a RESTful standard - full details are in restful-standards.md.

Build

I use doctoc (and grunt-doctoc) to keep the table of contents up to date.

To run that:

npm install
grunt

Create a PDF version

For those that want to have this as a PDF:

npm install
grunt pdf

This will create restful-standards.pdf

Create an HTML version

iFor those that want to have this as a HTML:

    npm install
    grunt html

This will create an html version in /html.