Skip to content
Finn Lippok edited this page Apr 9, 2023 · 7 revisions

REST API /api/v1/post

⚠️ Authorization Header: All requests must contain a Authorization Header.

Authorization Bearer {JWT-Token}

Create new Posts

Request

Endpoint: POST /api/v1/post

{
  "title": "String",
  "content": "String"
}

Response

{
  "id": "UUID",
  "title": "String",
  "content": "String",
  "user_id": "UUID",
  "user_name": "String",
  "date": "Datetime",
  "edited": "bool"
}

Get Posts

Request

Endpoint: GET /api/v1/post/ {id}

Response

{
  "id": "UUID",
  "title": "String",
  "content": "String",
  "user_id": "UUID",
  "user_name": "String",
  "date": "Datetime",
  "edited": "bool"
}

Delete Posts

Request

Endpoint: DELETE /api/v1/post/ {id}

Response

{
  "id": "UUID",
  "title": "String",
  "content": "String",
  "user_id": "UUID",
  "user_name": "String",
  "date": "Datetime",
  "edited": "bool"
}

Update Posts

Request

Endpoint: PUT /api/v1/post/ {id}

Response

{
  "id": "UUID",
  "title": "String",
  "content": "String",
  "user_id": "UUID",
  "user_name": "String",
  "date": "Datetime",
  "edited": "bool"
}

Search Posts

Request

Endpoint: GET /api/v1/post/search/ {query}/{page}

Response

{
  {
    "id": "UUID",
    "title": "String",
    "content": "String",
    "user_id": "UUID",
    "user_name": "String",
    "date": "Datetime",
    "edited": "bool"
  },
  {
    "id": "UUID",
    "title": "String",
    "content": "String",
    "user_id": "UUID",
    "user_name": "String",
    "date": "Datetime",
    "edited": "bool"
  },
}

Posts By User

Request

Endpoint: GET /api/v1/post/user/ {id}/{page}

Response

{
  {
    "id": "UUID",
    "title": "String",
    "content": "String",
    "user_id": "UUID",
    "user_name": "String",
    "date": "Datetime",
    "edited": "bool"
  },
  {
    "id": "UUID",
    "title": "String",
    "content": "String",
    "user_id": "UUID",
    "user_name": "String",
    "date": "Datetime",
    "edited": "bool"
  },
}

Latest posts

Request

Endpoint: GET /api/v1/post/page/ {page}

Response

{
  {
    "id": "UUID",
    "title": "String",
    "content": "String",
    "user_id": "UUID",
    "user_name": "String",
    "date": "Datetime",
    "edited": "bool"
  },
  {
    "id": "UUID",
    "title": "String",
    "content": "String",
    "user_id": "UUID",
    "user_name": "String",
    "date": "Datetime",
    "edited": "bool"
  },
}

Clone this wiki locally