https://github.com/shybovycha/oksana-api

SportEvents API
https://github.com/shybovycha/oksana-api

Last synced: 21 days ago
JSON representation

SportEvents API

• Host: GitHub
• URL: https://github.com/shybovycha/oksana-api
• Owner: shybovycha
• Created: 2014-11-16T20:33:55.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2014-11-17T22:28:24.000Z (about 10 years ago)
• Last Synced: 2024-11-03T21:57:50.187Z (2 months ago)
• Language: Ruby
• Size: 117 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Oksana' API

## Requests

Requests are directed to `/users` resource. E. g.:

* `GET /users` - list all users

* `POST /users/sign_up` - create a new user

Sample `sign_up` request (in Ruby using `rest-client` gem):

    RestClient.post 'localhost:9292/users/sign_up', { name: "moo", email: "[email protected]", password: "abc", password_confirmation: "abc" }

For now, implemented methods are:

* `GET /users`

* `POST /users/sign_up`

## Responses

Responses are just JSON objects. Each response contains either `{ "success": true }` or `{ "success": false, "error": "..." }` part.

### Available responses

`GET /users`

    { "success": true, "users": ["#"] }

`POST /users/sign_up`

    { "success": true, "id": 5, "api_key": "abcdef0123456789" }