Skip to content

r1411/AskAPI

Repository files navigation

REST API для сервиса вопросов и ответов

Доступна регистрация и аутентификация.

У пользователей есть следующие возможности:

  • Посмотреть список досок
  • Посмотреть список вопросов на доске
  • Посмотреть конкретный вопрос
  • Создать вопрос на одной из досок
  • Редактировать / удалить свой вопрос
  • Ответить на чужой вопрос
  • Редактировать / удалить свой ответ

Пользователи с ролью ADMIN также могут:

  • Создать / редактировать / удалить доску
  • Редактировать / удалить любой вопрос
  • Редактировать / удалить любой ответ

Требования:

Java 17

Docker

Для запуска локально:

  • PostgreSQL

Запуск в Docker:

  1. git clone https://github.com/r1411/AskAPI.git
  2. cd AskAPI
  3. Настроить переменные в .env
  4. ./mvnw package
  5. docker-compose up -d

Запуск локально:

(Не рекомендуется)

  1. Создать пользователя, базу и схему в БД
  2. git clone https://github.com/r1411/AskAPI.git
  3. cd AskAPI
  4. Отредактировать application.properties, подставив значения вручную
  5. ./mvnw package
  6. java -jar target/*.jar

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

После запуска документация доступна по пути /swagger-ui.html

About

Тестовый REST API на Spring для Q&A сервиса

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages