API

Get Articles

GET https://api.javabom.com/api/v1/articles

200

{
  "data": [
    {
      "type": "articles",
      "id": "1",
      "attributes": {
        "title": "Initial Article",
        "content": "This is content of article"
      },
      "links": {
        "self": "https://board-api/api/v1/articles/1"
      }
    },
    {
      "type": "articles",
      "id": "2",
      "attributes": {
        "title": "New Article",
        "content": "This is content of new article"
      },
      "links": {
        "self": "https://board-api/api/v1/articles/2"
      }
    }
  ]
}

204

Get an article

GET https://api.javabom.com/api/v1/articles/{articleId}

Path Parameters

Name	Type	Description
articleId	integer	article id

200

{
  "data": {
    "type": "articles",
    "id": "1",
    "attributes": {
      "title": "Initial Article",
      "content": "This is content of article"
    },
    "links": {
      "self": "https://board-api/api/v1/articles/1"
    }
  }
}

404

Post a new article

POST https://api.javabom.com/api/v1/articles

Request Body

Name	Type	Description
title	string	article title
content	string	article content

201

{
  "data": {
    "type": "articles",
    "id": "1",
    "attributes": {
      "title": "Initial Page",
      "content": "This is content of article"
    },
    "links": {
      "self": "https://board-api/api/v1/articles/1"
    }
  }
}

Template of POST request body

{
  "data": {
    "type": "articles",
    "attributes": {
      "title": "Initial Article",
      "content": "This is content of article"
    }
  }
}

Update an article

PUT https://api.javabom.com/api/v1/articles/{articleId}

Path Parameters

Name	Type	Description
articleId	integer	article id

Request Body

Name	Type	Description
title	string	article title
content	string	article content

200

{
  "data": {
    "type": "articles",
    "id": "1",
    "attributes": {
      "title": "Initial Article",
      "content": "This is modified content of article"
    },
    "links": {
      "self": "https://board-api/api/v1/articles/1"
    }
  }
}

404

Template of PUT request body

{
  "data": {
    "type": "articles",
    "attributes": {
      "title": "Initial Article"
    }
  }
}

{
  "data": {
    "type": "articles",
    "attributes": {
      "content": "This is modified content of article"
    }
  }
}

{
  "data": {
    "type": "articles",
    "attributes": {
      "title": "Initial Article",
      "content": "This is modified content of article"
    }
  }
}

Delete an article

DELETE https://api.javabom.com/api/v1/articles/{articleId}

Path Parameters

Name	Type	Description
articleId	integer	article id

200