dimacodes / personify-server

A directory of peoples' names and their favorite cities.

Personify. API

About

• Scalable API-only Rails application
• Developed utilizing TDD
• Responses thoroughly tested
• REST-compliant
• Allows cross-origin resource sharing
• Token-based authentication not required
• Current version is 1.0
• Serves JSON

Getting started

• The Personify. API allows access to a directory of peoples' names and their favorite cities
• The home address of the API is http://personify-server.herokuapp.com/api
• Several unique endpoints exist at that address

Reference

• Resources can be accessed via standard HTTP requests
• Parameters are required for most requests
• GET - /v1/people - see all people - parameters: none
• POST - /v1/people - create person - parameters: name, favoriteCity
• GET - /v1/people/:id - see person - parameters: id
• PUT - /v1/people/:id - modify person - parameters: name, favoriteCity
• DELETE - /v1/people/:id - delete person - parameters: id

Example

GET request to /v1/people:

$ http GET personify-server.herokuapp.com/api/v1/people
HTTP/1.1 200 OK
...
[
    {
        "created_at": "2017-03-24T05:40:00.864Z",
        "favoriteCity": "Miami",
        "id": 2,
        "name": "Sean Kingston",
        "updated_at": "2017-03-24T05:41:54.999Z"
    },
    {
        "created_at": "2017-03-24T05:42:23.863Z",
        "favoriteCity": "Kingston",
        "id": 3,
        "name": "Sean Paul",
        "updated_at": "2017-03-24T05:42:23.863Z"
    },
    {
        "created_at": "2017-03-24T04:53:55.476Z",
        "favoriteCity": "New York",
        "id": 1,
        "name": "Sean",
        "updated_at": "2017-03-24T18:10:24.963Z"
    }
]

Responses

• All data is delivered as a JSON object

Authentication

• Personify. API is available for public consumption
• No authentication token needed

Please visit Personify., an application built with the Personify API.