https://github.com/rainggor/jwtfunctest
pet project using Spring REST PostgreSql
https://github.com/rainggor/jwtfunctest
Last synced: about 2 months ago
JSON representation
pet project using Spring REST PostgreSql
- Host: GitHub
- URL: https://github.com/rainggor/jwtfunctest
- Owner: RaingGOR
- Created: 2023-12-02T10:13:33.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-15T19:50:35.000Z (about 2 years ago)
- Last Synced: 2025-03-11T03:54:15.573Z (about 1 year ago)
- Language: Java
- Homepage:
- Size: 109 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Попытка создания аниме сайта, но получилось то, что это приложение тестирование функционала jwt
___
# Web Anime Site
### Старая версия документации / Old version docs
**(RU) Данный pet-project разрабатывается на языке Java с использованием фреймворка Spring Boot и его компонентов.
Документация будет дополняться по мере разработки. Используемые технологии:**
* **_Spring Boot_**
* **_PostgreSQL_**
* **_Spring Security_**
* **_Lombok_**
* **_REST_**
* **_Modelmapper_**
___
**(ENG) This pet project is being developed in Java using the Spring Boot framework and its components. Documentation
will be updated as development progresses. Technologies used:**
* **_Spring Boot_**
* **_PostgreSQL_**
* **_Spring Security_**
* **_Lombok_**
* **_REST_**
* **_Modelmapper_**
## Documentation / Документация
___
### Содержание / Table of Contents:
* ***User Controller API Documentation***
* ***Models***
* ***Notes***
___
# User Controller API Documentation
### **Получение списка всех пользователей**
**Endpoint:** GET /users
**Описание:**
Этот эндпоинт возвращает список всех пользователей в системе.
***Запрос:***
```http request
GET /users
```
***Ответ:***
```json
[
{
"name": "Bob",
"password": "1234",
"email": "BobTest@gmail.com"
},
...
]
```
### Получение информации о конкретном пользователе по ID
**Endpoint:** GET /users/{id}
**Описание:**
Этот эндпоинт возвращает информацию о конкретном пользователе по заданному идентификатору.
***Запрос:***
```http request
GET /users/3
```
***Ответ:***
```json
{
"name": "Rob",
"password": "1234",
"email": "RobTest@gmail.com"
}
```
### Создание нового пользователя
**Endpoint:** POST /users/new
**Описание:**
Этот эндпоинт создает нового пользователя с использованием предоставленных данных.
***Запрос:***
```http request
POST /users/new
Content-Type: application/json
{
"name" : "Polly",
"password": "1234",
"email": "PolyTest@gmail.com"
}
```
***Ответ:***
```http request
200 OK
```
### Обновление информации о пользователе
**Endpoint:** POST /users/{id}/update
**Описание:**
Этот эндпоинт обновляет информацию о существующем пользователе по заданному идентификатору.
***Запрос:***
```http request
PATCH /users/123/update
Content-Type: application/json
{
"name": "Polly",
"password": "1234",
"email": "PolyTest@gmail.com"
}
```
***Ответ:***
````http request
200 OK
````
### Удаление пользователя
**Endpoint:** DELETE /users/{id}
**Описание:**
Этот эндпоинт удаляет пользователя по заданному идентификатору.
***Запрос:***
```http request
DELETE /users/{id}
```
***Ответ:***
```http request
200 OK
```
___
# Models
## *User*
### **Eng**
**Overview**:
The User class is a Java entity class representing user information. It is annotated with JPA annotations for
persistence and utilizes Lombok annotations to reduce boilerplate code.
#### Fields:
* ***id:*** An autogenerated identifier for the user.
* ***name:*** The user's name, with validation for non-empty and a length between 2 and 200 characters.
* ***password:*** The user's password, with validation for non-empty.
* ***email:*** The user's email address, with validation for a valid email format.
### **Ru**
**Обзор:**
Класс User является классом сущности на языке Java, представляющим информацию о пользователе. Он аннотирован аннотациями JPA для сохранения в базе данных и использует аннотации Lombok для уменьшения избыточного кода.
***Поля:***
* ***id:*** Автоматически генерируемый идентификатор пользователя.
* ***name:*** Имя пользователя с валидацией на непустоту и длину от 2 до 200 символов.
* ***password:*** Пароль пользователя с валидацией на непустоту.
* ***email:*** Адрес электронной почты пользователя с валидацией на корректный формат email.
___
# Примечания / Notes
### (RU):
* ***Все запросы и ответы осуществляются в формате JSON.***
### (ENG):
* ***All requests and responses in JSON format***
___