command pour run le serveur
poetry run serve
This route is used to create a new user.
input body:
{
"username" : String,
"password" : String,
"email" : String,
"name" : String,
"birthdate": String (yyyy/mm/dd)
}
output body, code 201:
{
"msg" : "creation succes"
}
This route is used to obtain an access token.
input body:
{
"username" : String,
"password" : String
}
output body connection succes, code 200
{
"access_token" : String,
"user":{
"username": String,
"profile_picture": String (image URL)
}
}
output body connection fail, code 401
{
"Error": "connection failure"
}
Access_token needed.
Check if the access token is still valid.
output body, code 200.
Access_token needed.
This route allows you to search for users using the 'search' parameter. By default, the route returns 12 users at a time. You can request additional users by specifying the 'page' parameter. If no search parameter is present, the route will search for all users. If no page parameter is specified, the first page is returned by default.
Please note that the list of followers and following is limited to 50. If you require more, you can make additional requests to GET /users/«username»/followers and GET /users/«username»/following
exemple :
api/users?search=...&page=int>0
output body, code 200:
[
{
"name": String,
"profile_picture": String (URL),
"username": String
},
...
]
Access_token needed.
This route provides all information about a user. If a user is viewing their own page, more information will be included in the output. The lists of followers and following are limited to 50 users each. If you require more, you can make additional requests using the following routes: GET /users/«username»/followers or GET /users/«username»/following.
The number of publications shown is limited to 12. If you require more, you can make additional requests using GET /users/«username»/publications.Similarly, the number of publications in a gallery is also limited to 12. If you require more, you can make additional requests using GET /galleries/«gallery_id»/publications.
Note that if the username does not match the access token, private galleries will not be shown.
output body if username doesn't match access_token, 200:
{
"age": int,
"biography": String,
"created_date": Sting,
"followed_by_user": Boolean,
"followers":[
{
"profile_picture": String (URL),
"username": String
},
...
],
"following":[
{
"profile_picture": String (URL),
"username": String
},
...
],
"galleries":[
{
"gallery_id": String
"publications": [
{
"picture": String (URL),
"publication_id": String
},
...
],
"pivate": Boolean,
"title": String
},
...
],
"name": String,
"nb_followes": int,
"nb_following": int,
"nb_publications": int,
"profile_picture": String (URL),
"publications" : [
{
"created_date": String,
"picture": String (URL),
"publication_id"
},
...
],
"username": String
}
output body if username belong to access_token, code 200:
{
"age": int,
"biography": String,
"birthdate": String,
"created_date": Sting,
"email": String,
"followers":[
{
"profile_picture": String (URL),
"username": String
},
...
],
"following":[
{
"profile_picture": String (URL),
"username": String
},
...
],
"galleries":[
{
"gallery_id": String
"publications": [
{
"picture": String (URL),
"publication_id": String
},
...
],
"private": Boolean,
"title": String
},
...
],
"name": String,
"nb_followes": int,
"nb_following": int,
"nb_publications": int,
"profile_picture": String (URL),
"publications" : [
{
"created_date": String,
"picture": String (URL),
"publication_id"
},
...
],
"username": String
}
Access_token needed.
This route allows modification of a user's data. Access is only granted to the user whose username matches the access token.
You can modify one or more parameters at a time. Simply send the field that needs to be updated.
input body:
{
"biography": String,
"email": String,
"password": String,
"username": String,
"name": String,
"profile_picture": image base64 or String (URL)
}
output body, code 200.
Access_token needed.
Access to this route is granted only to the user whose username matches the access token. This route is used to delete all data related to the user, including the user account itself.
output body, code 200.
Access_token needed.
This route returns the publications of the specified username. By default, the route returns up to 12 publications per page. To obtain additional publications, you can change the 'page' parameter to request the next batch of results. If the 'page' parameter is not specified, the first page of results is returned.
exemple :
api/users?page=int>0
output body, code 200:
[
{
"created_date": String,
"picture": String (URL),
"publication_id": String
},
...
]
Access_token needed.
This route is used to follow a user.
Access_token needed.
This route is used to unfollow a user.
Access_token needed.
This route returns a list of users who are following the specified user. By default, the list is limited to 50 users per page. To obtain additional results, you can change the 'page' parameter to request the corresponding page. If the 'page' parameter is not specified, the first page of results is returned.
exemple :
api/users/«username»/followers?page=int>0
output body, code 200:
[
{
"profile_picture": String (URL),
"username": String
},
...
]
Access_token needed.
This route returns a list of users who are being followed by the specified user. By default, the list is limited to 50 users per page. To obtain additional results, you can change the 'page' parameter to request the corresponding page. If the 'page' parameter is not specified, the first page of results is returned.
exemple :
api/users/«username»/following?page=int>0
output body, code 200:
[
{
"profile_picture": String (URL),
"username": String
},
...
]
Access_token needed.
This route returns an object containing the total number of publications and a list of up to 12 publications. To obtain the next batch of publications, you can change the 'page' parameter. The number of comments for each publication is also limited, but you can obtain additional comments by calling the GET /publications/«publication_id»/comments
exemple :
api/users/followed/publications?page=int>0
output body, code 200:
{
"nb_publications":int
"publication":[
{
"comments": [
{
"comment_id" : String,
"commenter_user":{
"profile_picture": String (URL),
"username": String
}
"created_date": String,
"message": String,
"rating" : int,
"user_rating": int
},
...
],
"created_date": String,
"description": String,
"nb_comments": Int,
"picture": String (URL),
"poster_user":{
"profile_picture": String(URL),
"username": String
}
"publication_id": String,
"rating": int,
"tags": [String],
"user_rating": int
},
...
]
}
Access_token needed.
This route is used to retrieve data for a specific comment.
Output body, code 200:
{
"comment_id": String,
"commenter_username": String,
"message": String,
"created_date": String,
"publication_id": String,
"rating": int
}
Access_token needed.
This route is used to change the message of a comment. Only the creator of the comment can access this route.
Input body:
{
"message":String
}
Accesss_token needed.
This route is used to delete a comment. Only the creator of the comment or the creator of the publication to which the comment belongs can access this route.
Access_token needed.
The purpose of this feature is to enable users to rate comments. Each user is limited to rating a comment only once.
Input body:
{
"rating": Boolean
}
Access_token needed.
This route allows users to update their rating of a comment they have previously rated.
Input body:
{
"rating": Boolean
}
Access_token needed.
The purpose of this route is to enable users to remove their rating on a comment.
Access_token needed.
The purpose of this route is to allow users to create a new gallery, which they can use to store and organize their images or other multimedia content.
Input body:
{
"description": String,
"title": String,
"private": Boolean
}
Access_token needed.
"The purpose of this route is to retrieve the data of a gallery. When retrieving the list of publications associated with the gallery, only the first 12 publications are included. To retrieve additional publications, the user must make a subsequent request using the GET /galleries/«gallery_id»/publications
Output body, code 200:
{
"created_date": String,
"creator_user": {
"profile_picture": String (URL),
"username": String
},
"description": String,
"gallery_id": String,
"nb_publicaitons": int,
"publications":[
{
"picture": String (URL),
"publications_id": String
},
...
],
"private": Boolean,
"rating": int,
"tile": String,
"user_rating" : int
}
Access_token needed.
The purpose of this route is to allow the creator of a gallery to modify it. Only the creator of the gallery has access to this route. The user can include one or more fields in the request body to specify the changes they want to make.
Input body:
{
"description": String,
"title": String,
"private": Boolean
}
Access_token needed.
The purpose of this route is to enable the creator of a gallery to delete it. Only the user who created the gallery has access to this route, and once the gallery is deleted, it cannot be restored.
Access_token needed.
The purpose of this route is to retrieve a list of publications associated with a gallery. The list is limited to 12 publications per page. To retrieve the next batch of publications, the user can change the page parameter accordingly. If the page parameter is not present, the endpoint returns the first page by default.
exemple:
GET /galleries/«gallery_id»/publications?page=int>0
Output body, code 200:
[
{
"picture": String (URL),
"publications_id": String
},
...
],
Access_token needed.
The purpose of this route is to allow the creator of a gallery to add a publication to it. Only the user who created the gallery has access to this route, and the added publication will be associated with the gallery.
Input body:
{
"publication_id": String
}
Access_token needed.
The purpose of this route is to enable the creator of a gallery to remove a publication from it. Only the user who created the gallery has access to this route, and the publication will be disassociated from the gallery.
Input body:
{
"publication_id": String
}
Access_token needed.
The purpose of this route is to allow users to rate a gallery. Each user can only rate a gallery once.
Input body:
{
"rating": Boolean
}
Output body, code 200.
Access_token needed.
The purpose of this route is to enable users to update their rating of a gallery that they have previously rated.
Input body:
{
"rating": Boolean
}
Access_token needed.
The purpose of this route is to allow users to remove their rating of a gallery.
Access_token needed.
The purpose of this route is to retrieve the most recent publications. The list is limited to 12 publications per page, and the user can retrieve the next batch of publications by including the page parameter. To retrieve publications related to a specific tag, the user can include the tag parameter. The same applies to retrieving comments for a publication, where the user can use the GET /publications/«publication_id»/comments endpoint to retrieve additional comments.
exemple:
GET /publications?page=int>0&tag=...
Output body, code 200:
{
"nb_publications": int,
"publications":[
{
"comments":[
{
"comment_id": String,
"commenter_user":{
"profile_picture": String (URL),
"username": String
},
"created_date": Sting,
"message": String,
"rating": int,
"user_rating": int
},
...
]
"created_date": String,
"description": String,
"nb_comments": int,
"picture": String (URL),
"poster_user":{
"profile_picture": String (URL),
"username": String
},
"publication_id": String,
"rating": int,
"tags": [String],
"user_rating": int
},
...
]
}
Access_token needed.
The purpose of this route is to enable users to create a new publication, which will be added to the list of existing publications.
Input body:
{
"description": String,
"picture": String (URL),
"tags": [String]
}
Access_token needed.
"The purpose of this route is to retrieve data for a specific publication, including its content and associated metadata. The list of comments associated with the publication is limited to 12 comments per page, and the user can retrieve additional comments by using the GET /publications/«publication_id»/comments
Output body, code 200:
{
"comments":[
{
"comment_id": String,
"commenter_user":{
"profile_picture": String (URL),
"username": String
},
"created_date": Sting,
"message": String,
"rating": int,
"user_rating": int
},
...
]
"created_date": String,
"description": String,
"nb_comments": int,
"picture": String (URL),
"poster_user":{
"profile_picture": String (URL),
"username": String
},
"publication_id": String,
"rating": int,
"tags": [String],
"user_rating": int
}
Access_token needed.
The purpose of this route is to allow the creator of a publication to modify its content and associated metadata. Only the user who created the publication has access to this route, and the user can specify one or more fields to modify in the request body.
Input body:
{
"tags": [String],
"description": String
}
Access_token needed.
The purpose of this route is to allow the creator of a publication to delete it. Only the user who created the publication has access to this route.
Output body, code 200.
Access_token needed.
The purpose of this route is to retrieve a list of comments associated with a publication. The list is limited to 12 comments per page, and the user can retrieve the next batch of comments by including the page parameter. If the page parameter is not present, the first page of comments will be returned by default.
exemple:
GET /publications/«publication_id»/comments?page=int>0
Output body, code 200:
[
{
"comment_id": String,
"commenter_user":{
"profile_picture": String (URL),
"username": String
},
"created_date": Sting,
"message": String,
"rating": int,
"user_rating": int
},
...
]
Access_token needed.
The purpose of this route is to allow users to create a new comment for a specific publication. Once the comment is created, it will be added to the list of comments associated with the publication.
Input body:
{
"message": String
}
Access_token needed.
The purpose of this route is to allow users to add a rating to a publication. Each user can only rate a publication once.
Input body:
{
"rating": Boolean
}
Access_token needed.
The purpose of this route is to allow a user to update their rating on a specific publication.
Input body:
{
"rating": Boolean
}
Access_token needed.
The purpose of this route is to allow a user to remove their rating from a specific publication.
Access_token needed.
The purpose of this route is to provide a search function that returns a list of tags based on the user's search parameter.
exemple:
GET /tags?search=...
Output body, code 200:
[
{
"nb_publications": int
"tag": String
},
...
]