Добро пожаловать в репозиторий RESP-API - приложения "Glossary"

Glossary

• API version: 1.0.0.
  • See Semantic Versioning
  • See Сonventional Сommits
• Build date: 2022-07-21

For more information, please visit https://github.com/Witcher26

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>io.swagger</groupId>
  <artifactId>swagger-java-client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Then manually install the following JARs:

• target/swagger-java-client-1.0.0.jar
• target/lib/*.jar

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/api

Class	Method	HTTP request	Description
AdminControllerApi	createDataBase	POST /adminController/v1/createDataBase	создание базы данных
AdminControllerApi	deleteDataBase	DELETE /adminController/v1/deleteDataBase	удаление базы данных
AdminControllerApi	getIsDatabaseInfo	GET /adminController/v1/getIsDatabaseInfo	получение информации о текущей базе данных
AdminControllerApi	getLoggerInfo	GET /adminController/v1/getLoggerInfo	логгер
AdminControllerApi	swichDataBase	POST /adminController/v1/switchDataBase/{isDataBase}	переключение баз данных
DatabaseControllerApi	readDatabase	GET /databaseController/v1/database/read	Ммтод чтения данных из базы данных
DatabaseControllerApi	updateDatabase	PUT /databaseController/v1/database/update	метод обнолвения базы данных
EngineControllerApi	engine	POST /engineController/v1/startEngine/{requestFromClientInJson}	метод добавления слова, удаления слова, вывод всех слов

Documentation for Authorization

All endpoints do not require authorization. please, see http://localhost:8080/swagger-ui/index.html

Author

1816178@mail.ru

---

Для того, чтобы начать пользоваться данным REST-API, необходимо проделать следующие шаги:

• развернуть приложение на компьютере и запустить его (внимание, приложение необходимо развернуть на локальном компьютере, поскольку на удаленном сервере его нет).
• запустить мануал по использованию:

• выбрать браузер:

---

Откроется интерактивное окно API-интерфейса:

---

либо воспользоваться альтернативным способом - перейдя по указанной ссылке, предварительно запустив приложение:

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

Результат будет таким же.

Первый блок - запросы администратора

• переключение баз данных (return String, Available values : POSTGRESQL, MONGODB, by default MONGODB);
• удаление базы данных (return Boolean, No parameters);
• создание базы данных (return Boolean, No parameters);
• получение информации от логгера (return String, No parameters);
• получение информации о текущей базе данных (return String, No parameters).

Второй блок - запросы к базе данных

• чтение из базы данных (return String, No parameters);
• обновление базы данных (return Boolean, No parameters);

Третий блок - запросы взаимодействия с хранилищем

Запрос представляет с собой json-строку

---

• ADD - добавление слова и его перевод (return Boolean, Available values: { "target": "ADD", "word": "test", "translation": "тестовое слово для проверки", "locale": "EN" })
• Remove - удаление слова (return Boolean, Available values: { "target": "REMOVE", "word": "test" })
• GETALLTASKS - вывод всех слов (return String, Available values: { "target": "GETALLTASKS" })

Пример интерактивного окна метода из группы контролера Engine