Flaze

Flaze - это API для создания и чтения статей. Этот проект предоставляет простой и удобный способ управления статьями через RESTful интерфейс.

Использование

Создание статьи

Чтобы создать новую статью, выполните HTTP POST запрос на /api/v1/articles/add с JSON телом статьи. Пример запроса:

POST /api/v1/articles/add
Content-Type: application/json

{
  "title": "Python",
  "description": "Высокоуровневый язык программирования",
  "text": "Python — высокоуровневый язык программирования общего назначения с динамической 
  строгой типизацией и автоматическим управлением памятью, 
  ориентированный на повышение производительности 
  разработчика, читаемости кода и его качества, 
  а также на обеспечение переносимости написанных на нём программ."
}

Чтение статьи

Чтобы прочитать статью, выполните HTTP GET запрос на /api/v1/articles/{id}, где {id} - это идентификатор статьи. Пример запроса:

GET /api/v1/articles/1

Удаление статьи

Чтобы удалить статью, выполните HTTP DELETE запрос на /api/v1/articles/{id}, где {id} - это идентификатор статьи. Пример запроса:

DELETE /api/v1/articles/1

Получение всех статей

Чтобы получить список всех статей, выполните HTTP GET запрос на /api/v1/articles. Пример запроса:

GET /api/v1/articles

Получение пользователя по имени пользователя

Чтобы получить информацию о пользователе по его имени пользователя, выполните HTTP GET запрос на /api/v1/users/{username}, где {username} - это имя пользователя. Пример запроса:

GET /api/v1/users/johndoe

Получение всех пользователей

Чтобы получить список всех пользователей, выполните HTTP GET запрос на /api/v1/users. Пример запроса:

GET /api/v1/users

Обновление имени пользователя

Чтобы обновить имя пользователя, выполните HTTP PUT запрос на /api/v1/users, передав новое имя пользователя в теле запроса. Пример запроса:

PUT /api/v1/users
Content-Type: application/json

{
  "newUsername": "newjohndoe"
}

Аутентификация

Чтобы аутентифицировать пользователя и получить JWT токен, выполните HTTP POST запрос на /api/v1/jwt/auth с JSON телом запроса, содержащим имя пользователя и пароль. Пример запроса:

POST /api/v1/jwt/auth
Content-Type: application/json

{
  "username": "johndoe",
  "password": "password123"
}

Регистрация нового пользователя

Чтобы зарегистрировать нового пользователя, выполните HTTP POST запрос на /api/v1/jwt/registration с JSON телом запроса, содержащим информацию о пользователе. Пример запроса:

POST /api/v1/jwt/registration
Content-Type: application/json

{
  "username": "johndoe",
  "password": "password123",
  "confirmPassword": "password123",
  "age": 15,
  "email": "[email protected]"
}

Авторизация

Для выполнения операций, связанных с созданием, удалением и обновлением статей, а также с доступом к защищённым ресурсам, требуется авторизация с использованием JWT токенов.

1. Получите JWT токен, выполнив запрос на /api/v1/jwt/auth.
2. Включите полученный токен в заголовок Authorization для всех последующих запросов, требующих авторизации.

Пример использования токена в запросе:

GET /api/v1/articles
Authorization: Bearer <ваш_токен>

Документация Swagger

Вы можете ознакомиться с документацией Swagger для этого API, перейдя по следующему URL:

http://localhost:8080/swagger-ui/index.html#/

Установка и запуск

1. Клонируйте репозиторий:

git clone https://github.com/yourusername/flaze.git

2. Перейдите в директорию проекта:

cd flaze

3. Соберите проект с помощью Maven:

mvn clean install

4. Запустите проект:

java -jar target/flaze-0.0.1-SNAPSHOT.jar

Лицензия

Этот проект лицензируется в соответствии с Лицензией MIT.