Python 3.11.5

Setup

Venv

python -m venv .venv
.venv\Scripts\activate

Install

pip install -r requirements.txt

Create DB Schema

In mysql, create schema "reclos"

Create .env

Copy .env.example to .env and fill in the values

Run Server

python manage.py makemigrations
python manage.py migrate
python manage.py runserver

API Reference

User

Get User(s)

GET /api/user/
GET /api/user/<int:id>/

Retrieves all users or a specific user by ID.

No parameters required for listing all users. For retrieving a specific user, the user ID is part of the URL path.

User Login

POST /api/user/login/

Allows users to log in and obtain authentication credentials.

Parameter	Type	Description
username	string	Required. Registered username
password	string	Required. Password

User Logout

POST /api/user/logout/

Logs out the current authenticated user.

User Check

GET /api/user/my/

Retrieves the current authenticated user's information.

Password Change

POST /api/user/password/change/

Allows an authenticated user to change their password.

Parameter	Type	Description
new_password1	string	Required. New password
new_password2	string	Required. Confirmation of new password

Password Reset

POST /api/user/password/reset/

Initiates a password reset process for a user.

Parameter	Type	Description
email	string	Required. Email for password reset

Password Reset Confirm

POST /api/user/password/reset/confirm/

Completes the password reset process.

Parameter	Type	Description
uid	string	Required. User's ID (base64 encoded)
token	string	Required. Password reset token
new_password1	string	Required. New password
new_password2	string	Required. Confirmation of new password

User Signup

POST /api/user/signup/

Registers a new user to the application.

Parameter	Type	Description
username	string	Required. Desired username
email	string	Required. Email address
password1	string	Required. Password
password2	string	Required. Password confirmation

Token Verification

POST /api/user/token/verify/

Verifies a token obtained from the login endpoint.

Parameter	Type	Description
token	string	Required. Token to verify

Token Refresh

POST /api/user/token/refresh/

Obtains a new access token using a refresh token.

Parameter	Type	Description
refresh	string	Required. Refresh token

Initiate Kakao Login

To start the Kakao login process, direct the user to the following URL:

https://kauth.kakao.com/oauth/authorize?client_id=<KAKAO_REST_API_KEY>&redirect_uri=<REDIRECT_URI>&response_type=code

Replace <KAKAO_REST_API_KEY> with your Kakao REST API Key and <REDIRECT_URI> with the URI where you want Kakao to send the response (this should match the one configured in your Kakao application settings). The user will be prompted to log in to Kakao and authorize your application.

Kakao Login

After the user logs in and authorizes the application, Kakao will redirect them to your specified redirect_uri with a code query parameter. Use this code to complete the login process:

GET /api/user/kakao/login/?code=<code>

This endpoint on your server should handle the code exchange for an access token and retrieve the user's information from Kakao.

Parameter	Type	Description
code	string	Required. Code provided by Kakao after user login

On success, this endpoint returns JWT tokens (access and refresh) along with the user's basic information.

Get User Level

GET /api/user/<int:id>/level/

Retrieves the level information of a specific user by their ID. This endpoint does not require authentication, allowing any user to view a specific user's level details.

Parameter	Type	Description
id	int	Required. The ID of the user whose level information is to be retrieved.

Update User Level

PUT /api/user/<int:id>/level/

Updates the level information for a specific user. This endpoint requires authentication and that the requester is the user whose level is being updated.

Parameter	Type	Description
id	int	Required. The ID of the user whose level is to be updated.
manner_level	int	Optional. The new manner level of the user.
water_level	int	Optional. The new water level of the user.
tree_level	int	Optional. The new tree level of the user.

Get User Closet

GET /api/user/<int:id>/closet/

Retrieves all closet items of a specific user by their ID. This endpoint does not require authentication, allowing any user to view a specific user's closet items.

Parameter	Type	Description
id	int	Required. The ID of the user whose closet items are to be retrieved.

Add Closet Item

POST /api/user/<int:id>/closet/

Allows a user to add a new item to their closet. This endpoint requires authentication and that the requester is the user adding the closet item.

Parameter	Type	Description
id	int	Required. The ID of the user adding a new closet item.
image	file	Required. The image file of the closet item.
cloth_type	string	Required. The type of the clothing item.

Update Closet Item

PUT /api/user/<int:id>/closet/<int:closet_id>/

Updates a specific closet item for a user. This endpoint requires authentication and that the requester is the user updating the closet item.

Parameter	Type	Description
id	int	Required. The ID of the user.
closet_id	int	Required. The ID of the closet item to update.

Delete Closet Item

DELETE /api/user/<int:id>/closet/<int:closet_id>/

Allows a user to delete a specific item from their closet. This endpoint requires authentication and that the requester is the user deleting the closet item.

Parameter	Type	Description
id	int	Required. The ID of the user.
closet_id	int	Required. The ID of the closet item to delete.

Dummy User

GET /api/user/dummy/

Creates a dummy user for testing purposes.

Board

List All Boards

GET /api/board/

Retrieves all boards. This endpoint does not require authentication, allowing any user to view all boards.

Retrieve a Specific Board

GET /api/board/<int:id>/

Retrieves a specific board by its id. This endpoint does not require authentication, allowing any user to view specific board details.

Parameter	Type	Description
id	int	Required. The ID of the board to retrieve.

Create a New Board

POST /api/board/

Allows an authenticated user to create a new board. This endpoint requires authentication.

Parameter	Type	Description
title	string	Required. The title of the board.
content	string	Required. The content of the board.
category	string	Optional. The category of the board.
images	file	Optional. Image files to upload.

To post a board with images, ensure the request's Content-Type is set to multipart/form-data.

Delete a Specific Board

DELETE /api/board/<int:id>/

Allows the author of a board to delete it. This endpoint requires authentication and authorship verification.

Parameter	Type	Description
id	int	Required. The ID of the board to delete.

Upon successful deletion, the server responds with a 204 No Content status code, indicating that the operation was successful but there is no content to return.

Like a Board

POST /api/board/<int:id>/like/

Allows a user to like a board. This endpoint toggles the like status of the board. If the user has already liked the board, the like will be removed (unliked), and if not, a like will be added.

Dummy Board

GET /api/board/dummy/

Creates dummy board data for testing purposes.

Imgen

AI server initialization

get /api/imgen/init/

ImageBackgroundRemove

get /api/imgen/rmbg/

Show all background remove images

ImageBackgroundRemove

post /api/imgen/rmbg/

Remove background from image, needs bearer token, image file in form-data

LadiVton

post /api/imgen/ladivton/

LadiVton, needs bearer token, {uuid[required], category(default:upper_body), reference_count(default:1)}