/JwtFuncTest

pet project using Spring REST PostgreSql

Primary LanguageJava

Попытка создания аниме сайта, но получилось то, что это приложение тестирование функционала 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

Описание: Этот эндпоинт возвращает список всех пользователей в системе.

Запрос:

GET /users

Ответ:

[
  {
    "name": "Bob",
    "password": "1234",
    "email": "BobTest@gmail.com"
  },
  ...
]

Получение информации о конкретном пользователе по ID

Endpoint: GET /users/{id}

Описание: Этот эндпоинт возвращает информацию о конкретном пользователе по заданному идентификатору.

Запрос:

GET /users/3

Ответ:

{
  "name": "Rob",
  "password": "1234",
  "email": "RobTest@gmail.com"
}

Создание нового пользователя

Endpoint: POST /users/new

Описание: Этот эндпоинт создает нового пользователя с использованием предоставленных данных.

Запрос:

POST /users/new
Content-Type: application/json

{
    "name" : "Polly",
    "password": "1234",
    "email": "PolyTest@gmail.com"
}

Ответ:

200 OK

Обновление информации о пользователе

Endpoint: POST /users/{id}/update

Описание: Этот эндпоинт обновляет информацию о существующем пользователе по заданному идентификатору.

Запрос:

PATCH /users/123/update
Content-Type: application/json

{
    "name": "Polly",
    "password": "1234",
    "email": "PolyTest@gmail.com"
}

Ответ:

200 OK

Удаление пользователя

Endpoint: DELETE /users/{id}

Описание: Этот эндпоинт удаляет пользователя по заданному идентификатору.

Запрос:

DELETE /users/{id}

Ответ:

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