library-api
A simple API for books.
Installation
- Fork and clone this repository.
- Change into the new directory.
- Install dependencies with
bundle install. - Add secrets to
config/secrets.yml. - Create a database with
bundle exec rake db:create. - Create a database schema with
bundle exec rake db:migrate. - Add data to the database with
bundle exec rake db:seed db:examples. - Run the HTTP server with
bundle exec rails server.
Structure
library-api follows the standard project structure for Rails 4.
User authentication is built-in.
curl command scripts are stored in scripts with names that
correspond to API actions.
Tasks
rake routeslists the endpoints available in your API.rake testruns automated tests.rails consoleopens a REPL that pre-loads the API.rails dbopens your database client and loads the correct database.rails serverstarts the API.scripts/*.shrun variouscurlcommands to test the API. See below.
API
books
| Verb | URI Pattern | Controller#Action |
|---|---|---|
| GET | /books |
books#index |
| GET | /books/:id |
books#show |
| POST | /books |
books#create |
| PATCH | /books/:id |
books#update |
| DELETE | /books/:id |
books#destroy |
GET /books
GET /books/:id
POST /books
PATCH /books/:id
DELETE /books/:id
Authentication
| Verb | URI Pattern | Controller#Action |
|---|---|---|
| POST | /sign-up |
users#signup |
| POST | /sign-in |
users#signin |
| PATCH | /change-password/:id |
users#changepw |
| DELETE | /sign-out/:id |
users#signout |
POST /sign-up
Request:
curl --include --request POST http://localhost:3000/sign-up \
--header "Content-Type: application/json" \
--data '{
"credentials": {
"email": "[email protected]",
"password": "an example password",
"password_confirmation": "an example password"
}
}'scripts/sign-up.shResponse:
HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
{
"user": {
"id": 1,
"email": "[email protected]"
}
}POST /sign-in
Request:
curl --include --request POST http://localhost:3000/sign-in \
--header "Content-Type: application/json" \
--data '{
"credentials": {
"email": "[email protected]",
"password": "an example password"
}
}'scripts/sign-in.shResponse:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"user": {
"id": 1,
"email": "[email protected]",
"token": "33ad6372f795694b333ec5f329ebeaaa"
}
}PATCH /change-password/:id
Request:
curl --include --request PATCH http://localhost:3000/change-password/$ID \
--header "Authorization: Token token=$TOKEN" \
--header "Content-Type: application/json" \
--data '{
"passwords": {
"old": "an example password",
"new": "super sekrit"
}
}'ID=1 TOKEN=33ad6372f795694b333ec5f329ebeaaa scripts/change-password.shResponse:
HTTP/1.1 204 No ContentDELETE /sign-out/:id
Request:
curl --include --request DELETE http://localhost:3000/sign-out/$ID \
--header "Authorization: Token token=$TOKEN"ID=1 TOKEN=33ad6372f795694b333ec5f329ebeaaa scripts/sign-out.shResponse:
HTTP/1.1 204 No ContentUsers
| Verb | URI Pattern | Controller#Action |
|---|---|---|
| GET | /users |
users#index |
| GET | /users/1 |
users#show |
GET /users
Request:
curl --include --request GET http://localhost:3000/users \
--header "Authorization: Token token=$TOKEN"TOKEN=33ad6372f795694b333ec5f329ebeaaa scripts/users.shResponse:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"users": [
{
"id": 2,
"email": "[email protected]"
},
{
"id": 1,
"email": "[email protected]"
}
]
}GET /users/:id
Request:
curl --include --request GET http://localhost:3000/users/$ID \
--header "Authorization: Token token=$TOKEN"ID=2 TOKEN=33ad6372f795694b333ec5f329ebeaaa scripts/user.shResponse:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"user": {
"id": 2,
"email": "[email protected]"
}
}License
Source code distributed under the MIT license. Text and other assets copyright General Assembly, Inc., all rights reserved.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent