SpringBootRestAPI

Шаблон Restapi - Spring Boot + Mongodb

Осаждение

Готовый к использованию шаблон для API REST с использованием Spring-Boot-Microservices, MongoDB в качестве базы данных, интегрированный с Codecov и Sonarqube, развертываемым в Cloud. Этот шаблон может быть подключен к любому приложению, чтобы легко KickStart Task, не записывая все с нуля.

Список задач Прогресс

• Контроллеры и модели отдыха с использованием Springboot
• Конфигурация MongoDB
• ТРЕВИСКИ Строительство
• Интеграция Sonarqube
• Отчет о тестировании Jacoco
• Jwt аутентификация
• 80% и выше покрытие кода (с помощью Codecov или Coverlls)
• Облачное развертывание

Начиная

• Импортируйте этот проект в свою любимую IDE после вилки и проверки этого репозитория.

Предварительная необходимость и установка шагов

• Получите управляемый экземпляр MongoDB, к которому вы можете подключиться. Для получения дополнительной информации о начале работы с MongoDB, посетите их онлайн -учебник.

• Начните с создания тестовой базы данных. Я назову свою «REST_TUTORIAL», используя следующую команду в оболочке MongoDB, или через менеджер базы данных, такой как MongoDB Compass: use rest_tutorial;

• Создайте образцы сбора, в котором будут храниться данные о различных типах домашних животных. Давайте создадим коллекцию со следующей командой: db.createCollection("pets");

• Как только коллекция создана, нам нужно добавить некоторые данные! We can add data to the collection with the below query, you can add any number of data like this : db.pets.insertMany([ { "name" : "Spot", "species" : "dog", "breed" : "pitbull" }, { "name" : "Daisy", "species" : "cat", "breed" : "calico" }, { "name" : "Bella", "species" : "dog", "breed" : "australian shepard" } ]);

• Добавьте монгодб-датабазу, имя пользователя и пароль в приложение.

• Создайте пользовательские роли в базе данных. Роли пользователя могут быть одним из «Пользовательский, модератор или администратор»

 db.roles.insertMany([
   { name: "ROLE_USER" },
   { name: "ROLE_MODERATOR" },
   { name: "ROLE_ADMIN" },
])

Запуск тестов

После того, как сервер запускается, вам первое необходимо зарегистрировать пользователя и входить в систему как этого пользователя, чтобы получить токен.

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

Пользовательский вход

После того, как вы получите токен, вам нужно передать этот токен для каждого запроса, который вы делаете в бэкэнд в почте, выберите раздел «Заголовок» и введите Authorization для ключа и
"Пресс -носитель" для значения

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

getallpets

getpetbyid

CreatePet

DeletePet

MODIFYPETBYID

После того, как это сделано со всеми тестированием, вы можете выходить из системы, используя конечную точку /api/auth/logout

выход

Покрытие кода

Для интеграции отчетов о покрытии кода я показал пример, используя Codecov и Coaplls, поскольку оба довольно популярны и просты в интеграции с Travis.

• Codecov - Просто добавьте эту строку в.

• Covealls - необходимо добавить Coipalls Plugin и Plagin и Plate Jacoco Report в файле build.gradle. Также необходимо изменение в .travis.yml вместо Codecov, чтобы использовать Coipalls

Запрос на вопрос

Are you up for your first Issue Request for this project !!! Потрясающе, но, пожалуйста, сначала пройдите через шаблон выпуска. MD и используйте этот шаблон, чтобы отправить любой запрос на вопрос.

Шаблон запроса вытянуть

Are you up for your first PR for this project !!! Потрясающе, но сначала пройдите через шаблон запроса на притяжение. MD и используйте этот шаблон, чтобы отправить свой PR.

Внося

Пожалуйста, прочитайте Anforming.md и Code of Pervate.md для получения подробной информации о нашем кодексе поведения и процессе отправки нам запросов.

Авторы

• Гувра Русия