Light

originerd / wecs Goto Github PK

View Code? Open in Web Editor NEW

0.0 2.0 0.0 164 KB

Web / API server for WECS

Home Page: http://wecs.herokuapp.com

Ruby 69.22% JavaScript 0.95% CoffeeScript 0.87% CSS 4.22% HTML 24.73%

wecs's Introduction

This app is an web service for untitled.

API

Users

Create a user
- Method
  - POST
- URL
  - http://wecs.herokuapp.com/api/v1/users
- Headers
  - Content-Type
- Parameters
  - user
    - email
    - name
    - password
    - password_confirmation
- Example
  - Request
    - URL
      - http://wecs.herokuapp.com/api/v1/users
    - Headers
      - Content-Type
        
        application/json
    - Parameter Body
      - {"user": {"email": "[email protected]", "name": "Name", "password": "password", "password_confirmation": "password"}}
  - Response
    - {"result": "success","user": {"id": 100,"email": "[email protected]","created_at": 2015-05-04T08:27:54.975+09:00","updated_at": 2015-05-04T08:27:54.975+09:00","name": "Name","auth_token": AUTH_TOKEN}}
Update a user
- Method
  - PUT
- URL
  - http://wecs.herokuapp.com/api/v1/users
- Headers
  - Content-Type
  - Authorization
- Parameters
  - user
    - email
    - name
    - password
    - password_confirmation
- Example
  - Request
    - URL
      - http://wecs.herokuapp.com/api/v1/users
    - Headers
      - Content-Type
        
        application/json
      - Authorization
        
        AUTH_TOKEN
    - Parameter Body
      - {"user": {"email": "[email protected]", "name": "Name", "password": "password", "password_confirmation": "password"}}
  - Response
    - {"result": "success","user": {"id": 100,"email": "[email protected]","created_at": 2015-05-04T08:27:54.975+09:00","updated_at": 2015-05-04T08:27:54.975+09:00","name": "Name","auth_token": AUTH_TOKEN}
Delete a user
- Method
  - DELETE
- URL
  - http://wecs.herokuapp.com/api/v1/users
- Headers
  - Authorization
- Paramters
  - None
- Example
  - Request
    - URL
      - http://wecs.herokuapp.com/api/v1/users
    - Authorization
      - AUTH_TOKEN
  - Response
    - {"result":"success"}

Sessions

Sign in
- Method
  - POST
- URL
  - http://wecs.herokuapp.com/api/v1/sessions
- Headers
  - Content-Type
- Parameters
  - session
    - email
    - password
- Example
  - Request
    - URL
      - http://wecs.herokuapp.com/api/v1/sessions
    - Headers
      - Content-Type
        
        application/json
    - Parameter Body
      - {"session": {"email": "[email protected]", "password": "password"}}
  - Response
    - {"result": "success","user": {"id": 100,"email": "[email protected]","created_at": 2015-05-04T08:27:54.975+09:00","updated_at": 2015-05-04T08:27:54.975+09:00","name": "Name","auth_token": AUTH_TOKEN}
Sign out
- Method
  - DELETE
- URL
  - http://wecs.herokuapp.com/api/v1/sessions
- Headers
  - Authorization
- Paramters
  - None
- Example
  - Request
    - URL
      - http://wecs.herokuapp.com/api/v1/sessions
    - Headers
      - Authorization
        
        AUTH_TOKEN
  - Response
    - {"result": "success"}

Boxes

Read all boxes
- Method
  - GET
- URL
  - http://wecs.herokuapp.com/api/v1/boxes
- Headers
  - Authorization
- Parameters
  - None
- Example
  - Request
    - URL
      - http://wecs.herokuapp.com/api/v1/boxes
    - Headers
      - Authorization
        
        AUTH_TOKEN
  - Response
    - {"result": "success", "boxes": [{"id": 100,"user_id": 100,"name": "EXAMPLE1","description": "EXAMPLE1","created_at": "2015-05-23T18:00:32.589Z","updated_at": "2015-05-23T18:00:32.589Z"}},{"id": 101,"user_id": 101,"name": "EXAMPLE2","description": "EXAMPLE2","created_at": "2015-05-23T18:00:32.589Z","updated_at": "2015-05-23T18:00:32.589Z"}},{"id": 102,"user_id": 102,"name": "EXAMPLE3","description": "EXAMPLE3","created_at": "2015-05-23T18:00:32.589Z","updated_at": "2015-05-23T18:00:32.589Z"}]}
Read a box
- Method
  - GET
- URL
  - http://wecs.herokuapp.com/api/v1/users/(:id)
- Headers
  - Authorization
- Paramters
  - None
- Example
  - Request
    - URL
      - http://wecs.herokuapp.com/api/v1/users/100
    - Headers
      - Authorization
        
        AUTH_TOKEN
  - Response
    - {"result": "success","box": {"id": 100,"user_id": 100,"name": "EXAMPLE","description": "EXAMPLE","created_at": "2015-05-23T18:00:32.589Z","updated_at": "2015-05-23T18:00:32.589Z"}}
Create a box
- Method
  - PUT
- URL
  - http://wecs.herokuapp.com/api/v1/boxes
- Headers
  - Content-Type
  - Authorization
- Parameters
  - box
    - name
    - description
- Example
  - Request
    - URL
      - http://wecs.herokuapp.com/api/v1/boxes
    - Headers
      - Content-Type
        
        application/json
      - Authorization
        
        AUTH_TOKEN
    - Parameter Body
      - {"box":{"name":"EXAMPLE", "description":"EXAMPLE"}}
  - Response
    - {"result": "success","box": {"id": 100,"user_id": 100,"name": "EXAMPLE","description": "EXAMPLE","created_at": "2015-05-23T18:00:32.589Z","updated_at": "2015-05-23T18:00:32.589Z"}}
Update a box
- Method
  - PUT
- URL
  - http://wecs.herokuapp.com/api/v1/boxes/(:id)
- Headers
  - Content-Type
  - Authorization
- Parameters
  - box
    - name
    - description
- Example
  - Request
    - URL
      - http://wecs.herokuapp.com/api/v1/boxes/100
    - Headers
      - Content-Type
        
        application/json
      - Authorization
        
        AUTH_TOKEN
    - Parameter Body
      - {"box":{"name":"EXAMPLE", "description":"EXAMPLE"}}
  - Response
    - {"result": "success","box": {"id": 100,"user_id": 100,"name": "EXAMPLE","description": "EXAMPLE","created_at": "2015-05-23T18:00:32.589Z","updated_at": "2015-05-23T18:00:32.589Z"}}
Delete a box
- Method
  - DELETE
- URL
  - http://wecs.herokuapp.com/api/v1/boxes/(:id)
- Headers
  - Authorization
- Paramters
  - None
- Example
  - Request
    - URL
      - http://wecs.herokuapp.com/api/v1/boxes/100
    - Authorization
      - AUTH_TOKEN
  - Response
    - {"result":"success"}

wecs's People

Contributors

Watchers

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.