/spring-boot-post-restful-api

Primary LanguageJava

field type description default example
tags String (required) A comma separated list of tags. N/A science,tech
sortBy String (optional) The field to sort the posts by. The acceptable fields are:
● id
● reads
● likes
● popularity		 id popularity
direction String (optional) The direction for sorting. The acceptable fields are:
● desc
● asc		 asc asc

Successful Response:

http://localhost:8080/api/posts?tags=history,tech&sortBy=likes&di

[
    {
        "id": 2,
        "author": "Zackery Turner",
        "likes": 469,
        "popularity": 0.68,
        "reads": 90406,
        "tags": [
            "startups",
            "tech",
            "history"
        ]
    },
    {
        "id": 1,
        "author": "Rylee Paul",
        "likes": 960,
        "popularity": 0.13,
        "reads": 50361,
        "tags": [
            "tech",
            "health"
        ]
    }
]

Error Responses:

  • If tags parameter is not present:
{
    "error": "tags parameter is required"
}
										Response status code: 400
  • If sortBy parameter is invalid:
{
    "error": "sortBy parameter is invalid"
}
										Response status code: 400