doc.apib

FORMAT: 1A

# Template Ruby Grape API

This project is a simple template API uses Grape framework and Ruby language.

# Group Project

Resources related to Project in the API.

## Project Collection [/projects]

### List the only one Project [GET]
+ Response 200 (application/json)
    + Attributes (Project)

### Create a new Project [POST]
+ Request (application/json)
    + Attributes
        + name: Project name (string, required)
        + description: Project description (string)

+ Response 201 (application/json)
    + Attributes (Project)

## Project [/projects/{id}]

### Delete a Project [DELETE]
+ Parameters
    + id (number, required) - Project ID

+ Response 204

### Update a Project [PUT]
+ Parameters
    + id (number, required) - Project ID

+ Request (application/json)
    + Attributes
        + name: Project name (string, required)
        + description: Project description (string, required)

+ Response 200 (application/json)
    + Attributes (Project)

## Data Structures

### Project (object)
+ id: 1 (number, required)
+ name: Project name (string, required)
+ description: Project description (string)