posts

la référence de l'endpoint posts

obtenir tout les posts

GET /api/posts/all

obtient tout les posts

Query Parameters

Name	Type	Description
limit		limite de la taille de la réponse(défauts: 30)
page		paginations(défauts: 1) note: paginations en fonction de la limite de la taille de la réponse

200: OK récupère tout les posts(sans limites et sans paginations

{
    "posts": [
        {
            "title": "test 1",
            "content": "content 01 modified !",
            "image": "rowimage.png",
            "slug": "test-1"
        },
        {
            "title": "test 2",
            "content": "content 02",
            "image": "image.png",
            "slug": "test-2"
        },
        {
            "title": "test 3",
            "content": "content 03",
            "image": "image.png",
            "slug": "test-3"
        },
        {
            "title": "test 4",
            "content": "content 04",
            "image": "image.png",
            "slug": "test-4"
        },
        {
            "title": "test 5",
            "content": "content 05",
            "image": "image.png",
            "slug": "test-5"
        }
    ],
    "limit": 30,
    "page": 1
}

200: OK tout les posts(avec limites et paginations)

{
    "posts": [
        {
            "title": "test 1",
            "content": "content 01 modified !",
            "image": "rowimage.png",
            "slug": "test-1"
        },
        {
            "title": "test 2",
            "content": "content 02",
            "image": "image.png",
            "slug": "test-2"
        },
        {
            "title": "test 3",
            "content": "content 03",
            "image": "image.png",
            "slug": "test-3"
        },
        {
            "title": "test 4",
            "content": "content 04",
            "image": "image.png",
            "slug": "test-4"
        }
    ],
    "limit": 4,
    "page": 1
}

obtenir un post avec son slug

GET /api/posts/get?by=slug

obtient un post unique avec son slug

Query Parameters

Name	Type	Description
query*	string	slug du post a récupérer
by*	string	type de recherche(slug par defaut)

200: OK post récupérer avec succès

{
    "title": "test 2",
    "content": "content 02",
    "image": "image.png",
    "slug": "test-2"
}

404: Not Found post non trouvé

{
    "error": true,
    "message": "post not found"
}

400: Bad Request requête mal formé

{
    "error": true,
    "message": "request malformed"
}

obtenir tout les posts d'un auteur

GET /api/posts/get?by=author

obtient tout les posts d'un auteur

Query Parameters

Name	Type	Description
query*	string	nom de l'auteur
by*	string	type de recherche(author pour notre cas)

200: OK tout les posts on bien été récupéré

{
    "posts": [
        {
            "title": "titre du post !",
            "content": "content 01",
            "image": "image.png",
            "authorName": "jokay03J",
            "slug": "titre-du-post-!"
        }
    ],
    "length": 1

400: Bad Request requête mal formé

{
    "error": true,
    "message": "request malformed"
}

404: Not Found l'auteur n'a publié aucun post

{
    "error": true,
    "message": "post not found"
}

création d'un nouveaux post

POST /api/posts/create

crée un nouveau post

Request Body

Name	Type	Description
title*	string	titre du post
content*	string	contenu du post
image*	string	image du post
authorName*	string	surnom du propriétaire du post

201: Created ça bien crée le post

{
    "title": "titre du post !",
    "content": "content 05",
    "image": "image.png",
    "authorName": "jokay03J"
}

409: Conflict le post existe déjà

{
    "error": true,
    "message": "post already exist"
}

400: Bad Request requête malformer

{
    "error": true,
    "message": "request malformed"
}

supprimer un post

DELETE /api/posts/delete

supprime le post avec son slug

Query Parameters

Name	Type	Description
query*	string	slug du post à supprimer

204: No Content a bien supprimer le post

404: Not Found le post à supprimer n'est pas trouver

{
    "error": true,
    "message": "post not found"
}

400: Bad Request la requête est malformer

{
    "error": true,
    "message": "request malformed"
}

modifier un post

PUT /api/posts/put

modifie un post

Request Body

Name	Type	Description
title	string	titre du post
content	string	contenu du post
image	string	image du post

200: OK le post

{
    "title": "test 1",
    "content": "content 01 modified",
    "image": "rowimage.png",
    "slug": "test-1"
}

304: Not Modified rien n'a été modifier

404: Not Found le post à modifier n'a pas été trouver

{
    "error": true,
    "message": "post not found"
}