echo-mongo-api

command module
Version: v0.0.0-...-12f1c74 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 10, 2017 License: BSD-3-Clause Imports: 5 Imported by: 0

README

Golang API + Mongo database

Running

Run docker-compose up -d

Signup

User signup

Retrieve user credentials from the body and validate against database. For invalid email or password, send 400 - Bad Request response. For valid email and password, save user in database and send 201 - Created response.

Request

curl \
  -X POST \
  http://localhost:1323/signup \
  -H "Content-Type: application/json" \
  -d '{"email":"jon@doe.com","password":"secret"}'

Response

201 - Created

{
  "id": "58465b4ea6fe886d3215c6df",
  "email": "jon@doe.com",
  "password": "secret"
}

Login

User login

Retrieve user credentials from the body and validate against database. For invalid credentials, send 401 - Unauthorized response. For valid credentials, send 200 - OK response: Generate JWT for the user and send it as response. Each subsequent request must include JWT in the Authorization header. Method: POST
Path: /login

Request

curl \
  -X POST \
  http://localhost:1323/login \
  -H "Content-Type: application/json" \
  -d '{"email":"jon@doe.com","password":"secret"}'

Response

200 - OK

{
  "id": "58465b4ea6fe886d3215c6df",
  "email": "jon@doe.com",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODEyNjUxMjgsImlkIjoiNTg0NjViNGVhNmZlODg2ZDMyMTVjNmRmIn0.1IsGGxko1qMCsKkJDQ1NfmrZ945XVC9uZpcvDnKwpL0"
}

Client should store the token, for browsers, you may use local storage.

Follow

Follow a user

For invalid token, send 400 - Bad Request response. For valid token: If user is not found, send 404 - Not Found response. Add a follower to the specified user in the path parameter and send 200 - OK response. Method: POST Path: /follow/:id

Request

curl \
  -X POST \
  http://localhost:1323/follow/58465b4ea6fe886d3215c6df \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODEyNjUxMjgsImlkIjoiNTg0NjViNGVhNmZlODg2ZDMyMTVjNmRmIn0.1IsGGxko1qMCsKkJDQ1NfmrZ945XVC9uZpcvDnKwpL0"

Response

200 - OK

Post

Post a message to specified user

For invalid request payload, send 400 - Bad Request response. If user is not found, send 404 - Not Found response. Otherwise save post in the database and return it via 201 - Created response. Method: POST
Path: /posts

Request

curl \
  -X POST \
  http://localhost:1323/posts \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODEyNjUxMjgsImlkIjoiNTg0NjViNGVhNmZlODg2ZDMyMTVjNmRmIn0.1IsGGxko1qMCsKkJDQ1NfmrZ945XVC9uZpcvDnKwpL0" \
  -H "Content-Type: application/json" \
  -d '{"to":"58465b4ea6fe886d3215c6df","message":"hello"}'

Response

201 - Created

{
  "id": "584661b9a6fe8871a3804cba",
  "to": "58465b4ea6fe886d3215c6df",
  "from": "58465b4ea6fe886d3215c6df",
  "message": "hello"
}

Feed

List most recent messages based on optional page and limit query parameters

Method: GET
Path: /feed?page=1&limit=5

Request

curl \
  -X GET \
  http://localhost:1323/feed \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0ODEyNjUxMjgsImlkIjoiNTg0NjViNGVhNmZlODg2ZDMyMTVjNmRmIn0.1IsGGxko1qMCsKkJDQ1NfmrZ945XVC9uZpcvDnKwpL0"

Response

200 - OK

[
  {
    "id": "584661b9a6fe8871a3804cba",
    "to": "58465b4ea6fe886d3215c6df",
    "from": "58465b4ea6fe886d3215c6df",
    "message": "hello"
  }
]

License

BSD 3-Clause

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto