Blog v1.0.0

[ Base URL: api.example.com/v1 ]

This is a sample Blog API description…

articles ⟩

GET

/articles

Returns all articles ↵

Parameters

Name Type Description
limit integer Maximum number of results to return
category string Category ID of articles that needs to be fetched

Responses

Status Body
200 
[
  {
    "id": 1234,
    "title": "My article",
    "content": "Lorem ipsum dolor sit amet..."
  },
  {
    "id": "..."
  }
]
404 
"Not found"
500 
"Bad request"
GET

/articles/:id

Returns the article of the given ID ↵

Responses

Status Body
200 
{
  "id": 1234,
  "title": "My article",
  "content": "Lorem ipsum dolor sit amet..."
}
POST

/articles

Create an article
PUT

/articles/:id

Update the given article
DELETE

/articles

Delete an article

comments ⟩

GET

/articles/:article_id/comments

Returns comments related to the given article