mguinea / lumen-ddd-realworld-example Goto Github PK

GET /api/profiles/:username

Authentication optional, returns a Profile

POST /api/profiles/:username/follow

Authentication required, returns a Profile

No additional parameters required

DELETE /api/profiles/:username/follow

Authentication required, returns a Profile

No additional parameters required

As user, I want to register to platform calling to a endpoint

POST /api/users

with request payload:

{
  "user":{
    "username": "Jacob",
    "email": "[email protected]",
    "password": "jakejake"
  }
}

No authentication required, returns a User

Required fields: email, username, password.

PUT /api/user

Example request body:

{
  "user":{
    "email": "[email protected]",
    "bio": "I like to skateboard",
    "image": "https://i.stack.imgur.com/xHWG8.jpg"
  }
}

Authentication required, returns the User

Accepted fields: email, username, password, image, bio

As user, I want to log in the platform using the following endpoint:

POST /api/users/login

Example request body:

{
  "user":{
    "email": "[email protected]",
    "password": "jakejake"
  }
}

No authentication required, returns a User

Required fields: email, password

As User, I want to get my user.

GET /api/user

Authentication required, returns a User that's the current user

GET /api/articles/:slug

No authentication required, will return single article

Used in user creation and update events, to sync with author profiles

Separate contexts