Это приложение на основе Spring Boot, которое реализует REST API для проверки корректности размещения скобок в тексте. Оно предоставляет точку доступа по адресу http://localhost:8080/api/checkBrackets, которая принимает POST-запросы для проверки размещения скобок.

Чтобы запустить это приложение локально, выполните следующие шаги:

1. Клонируйте этот репозиторий на свой локальный компьютер.

2. Убедитесь, что у вас установлены Java SDK 18 и Maven.

3. Перейдите в директорию проекта и выполните следующую команду для сборки приложения:

   mvn clean install
   

4. Запустите приложение с помощью следующей команды:

   java -jar target/BeautifulCodeApplication-1.0.jar
   

5. Приложение будет запущено, и вы сможете получить доступ к API по адресу http://localhost:8080/api/checkBrackets.

Для использования API, вы можете отправить POST запрос на адрес http://localhost:8080/api/checkBrackets с текстом для проверки в теле запроса. API вернет ответ о корректности расстановки скобок в переданном тексте.

Пример запроса с использованием cURL:

curl -X POST http://localhost:8080/api/checkBrackets -H "Content-Type: application/json" -d '{"text": "Текст с расставленными скобками (как пример)" }'

Пример ответа:

{
  "isCorrect": true
}

• isCorrect: true, если размещение скобок корректно, false в противном случае.

6. Тесты

В проекте также предусмотрены unit-тесты и интеграционные тесты с использованием Mockito и JUnit5. Тесты проверяют корректность работы BracketCheckerService и BracketCheckerController при проверке правильности расстановки скобок.

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

mvn test

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

Для заупска документации

mvn clean install

Перейдите в каталог target\ и запустите

jar -xf BeautifulCode-0.0.1-SNAPSHOT-javadoc.jar

Далее откройте index.html с документацией

open index.html

Приложение использует BracketCheckerService для проверки корректности размещения скобок в предоставленном тексте. Оно подсчитывает количество открывающих и закрывающих скобок и проверяет, сбалансированы ли они. BracketCheckerController обрабатывает HTTP-запросы и возвращает результат проверки в ответе.

Главный класс приложения для запуска Spring Boot приложения.

Контроллер, обрабатывающий HTTP-запросы и возвращающий ответ о корректности расстановки скобок.

Сервис для проверки корректности расстановки скобок в тексте.

Интерфейс, предоставляющий контракт для проверки корректности ресурса.

Класс, представляющий ответ на проверку корректности расстановки скобок.

Класс, представляющий текст, получаемый с POST запроса.

• [Автор: Биктагиров Айнур]

• Версия 1.0

Пользуйтесь проверкой корректности размещения скобок с Красивым Кодом!