neocoast / neoposts-cande

API Documentation

POST api/auth/sign_in

• Params: None

• Body: Json containing valid user's email and password

• Headers: None

Responses

• Success 200: renders the users data

{
  "data": {
    "email": "[email protected]",
    "provider": "email",
    "uid": "[email protected]",
    "id": 1,
    "first_name": "Juan",
    "last_name": "Lopez",
    "nickname": "juaan",
    "birthday": "2023-10-13"
  }
}

• Unauthorized 401: renders the following error

  {
    "success": false,
    "errors": [
      "Invalid login credentials. Please try again."
    ]
  }

GET api/v1/users

• Params: None

• Body: None

• Headers: Bearer token, client and uid. uid is the user's email and bearer token and client can be retrieved from the headers of the response of signing in the user (/api/auth/sign_in)

Responses

• Success 200: Renders all users with their ids, nicknames, first names, last names and birthdays in JSON format.

  [
    {
      "id": 1,
      "email": "[email protected]",
      "nickname": "juaaan",
      "first_name": "Juan",
      "last_name": "Lopez",
      "birthday": "2001-06-15"
    },

    {
      "id": 2,
      "email": "[email protected]",
      "nickname": "maria",
      "first_name": "Maria",
      "last_name": "Sanchez",
      "birthday": "1998-09-28"
    },

    {
      "id": 3,
      "email": "[email protected]",
      "nickname": "Jose",
      "first_name": "Jose",
      "last_name": "Perez",
      "birthday": "2002-10-21"
    },
  ]

• Unauthorized 401: renders the following error

  {
    "errors": [
      "You need to sign in or sign up before continuing."
    ]
  }

GET api/v1/users/:user_id/posts

• Params: None

• Body: None

• Headers: Bearer token, client and uid. uid is the user's email and bearer token and client can be retrieved from the headers of the response of signing in the user (/api/auth/sign_in)

Responses

• Success 200: Renders all user's posts with their ids, titles, bodies, pubished_at, user_id, comment_count and likes_count attributes.

  [
    {
      "id": 1,
      "title": "title1",
      "body": "body for the first post",
      "published_at": "2023-10-19T15:00:26.269Z",
      "user_id": 11,
      "comments_count": 0,
      "likes_count": 11
    },

    {
      "id": 2,
      "title": "title 2",
      "body": "body for the second post",
      "published_at": "2023-10-19T15:00:26.269Z",
      "user_id": 11,
      "comments_count": 4,
      "likes_count": 1
    },
  ]

• Unauthorized 401: renders the following error

  {
    "errors": [
      "You need to sign in or sign up before continuing."
    ]
  }

if the user with user_id does not exist it render the following error

  {
    "message": "User does not exist"
  }

GET api/v1/posts/:post_id

• Params: None

• Body: None

• Headers: Bearer token, client and uid. uid is the user's email and bearer token and client can be retrieved from the headers of the response of signing in the user (/api/auth/sign_in)

Responses

• Success 200: Renders posts id, title, body, pubished_at, user_id attributes and post's likes and comments.

  {
    "id": 1,
    "title": "title1",
    "body": "body for the first post",
    "published_at": "2023-10-16T16:57:59.301Z",
    "user_id": 1,
    "likes": [
        {
          "user_id": 1,
          "nickname": "juan"
        },
        {
          "user_id": 2,
          "nickname": "maria"
        }
    ],
    "comments": [
      {
        "id": 1,
        "content": "comment1",
        "replies": [
          {
            "id": 2,
            "content": "comment del comment1",
            "replies": []
          }
        ]
      },
      {
        "id": 3,
        "content": "otro comment del post",
        "replies": []
      },
      {
        "id": 4,
        "content": "y otro comentario del post",
        "replies": [
          {
            "id": 5,
            "content": "comment del tercer comment del post",
            "replies": [
              {
                "id": 6,
                "content": "comment del comment del tercer comment del post",
                "replies": []
              }
            ]
          }
        ]
      }
    ]
  }

• Unauthorized 401: renders the following error

  {
    "errors": [
      "You need to sign in or sign up before continuing."
    ]
  }

if the post with post_id does not exist it render the following error

  {
    "message": "Post does not exist"
  }

POST api/v1/users/:user_id/posts

• Params: None

• Body: json containing title and body of the post

• Headers: Bearer token, client and uid. uid is the user's email and bearer token and client can be retrieved from the headers of the response of signing in the user (/api/auth/sign_in)

Responses

• Success 200: Renders the created post with its id, title, body, pubished_at, user_id, comment_count and likes_count attributes.

  {
    "id": 1,
    "title": "title1",
    "body": "body for the first post",
    "published_at": "2023-10-19T15:00:26.269Z",
    "user_id": 11,
    "comments_count": 0,
    "likes_count": 0
    },

• Bad request 400: renders the following error for body or title

{
  "errors": {
    "body": [
      "can't be blank"
    ]
  }
}

{
  "errors": {
    "title": [
      "can't be blank"
    ]
  }
}

• Unauthorized 401: renders the following error if the headers are not provided

  {
    "errors": [
      "You need to sign in or sign up before continuing."
    ]
  }

or this one in case if there is no user with that user_id or in case the user_id from the route is not the logged in user

  {
    "message": "Unauthorized"
  }

PUT api/v1/posts/:post_id

• Params: None

• Body: json containing title and body for the post

• Headers: Bearer token, client and uid. uid is the user's email and bearer token and client can be retrieved from the headers of the response of signing in the user (/api/auth/sign_in)

Responses

• Success 200: Renders the updated post with its id, title, body, pubished_at, user_id, comment_count and likes_count attributes.

  {
    "id": 1,
    "title": "title1",
    "body": "body for the first post",
    "published_at": "2023-10-19T15:00:26.269Z",
    "user_id": 11,
    "comments_count": 0,
    "likes_count": 0
    },

• Bad request 400: renders the following error for body or title

{
  "errors": {
    "body": [
      "can't be blank"
    ]
  }
}

{
  "errors": {
    "title": [
      "can't be blank"
    ]
  }
}

• Unauthorized 401: renders the following error

  {
    "errors": [
      "You need to sign in or sign up before continuing."
    ]
  }

if the post with post_id does not exist it render the following error

  {
    "message": "Unauthorized"
  }