База данных сотрудников

Ссылка на документацию по API

База Данных сотрудниктов

Краткое описание, о чем проект:

Первое, с чего стоит начать - ознакомиться со спецификацией, по которой предстоит реализовывать API. Выше есть ссылка: "Ссылка на документацию по API", кликаем на неё, откроется Swagger (что такое Swagger) со всеми необходимыми точками доступа приложения (эндпоинтами).

Эта спецификация является достаточной, и только глядя на неё уже можно брать и реализовывать API, но об этом подробнее чуть ниже.

Необходимо реализовать приложение, которое предоставляет методы HTTP API, чтобы к нему могли подключаться другие приложения извне. Список методов для реализации описан в документации по API по ссылке выше. В документации описано какие запросы будет отправлять Groxin вашему приложению и в каком формате. Ваше приложение должно уметь создавать сотрудников, назначать должности, предоставлять данные внешнему приложению и позволять редактировать данные. Значит что ваше приложение должно не только реализовать API, но и работать с базой данных, для хранения информаци. 

После того, как API реализовано и готово к использованию, с помощью Ngrok (Что это такое?) открываем туннель до вашего API, чтобы академия смогла отправлять на него запросы. Копируем домен, который дал нам ngrok и вставляем в поле "Домен для тестирования", в нижней части консоли, и жмём синюю кнопку, должен начаться тест, в консоли должны начать появляться сообщения о прогрессе тестирования.

Помимо самой спецификации мы можем также добавлять другие условия и проверки для них. Представим, что у нас есть точка доступа (эндпоинт) профиля пользователя. Мы можем зайти в профиль к любому юзеру по ссылке example.com/someUsername, и можем зайти к себе в профиль по ссылке example.com/me. В таком случае, API должен запрещать создавать юзеров с логином me. В спецификации такие моменты мы можем указывать где-то в описании эндпоинта, но не факт, что пользователь там это увидит, поэтому, возможно, стоит дублировать и в описании проекта.