Skip to content

Latest commit

 

History

History
100 lines (59 loc) · 4.93 KB

File metadata and controls

100 lines (59 loc) · 4.93 KB

Памятка по работа с бэкендом

Первым делом тебе нужно завести аккаунт разработчика. Для этого перейди по адресу:

https://c-gallery.polinashneider.space/

Введи свою почту и придумай пароль

Create Account

Получение токена

Если регистрация прошла успешно, система тебе выдаст две строки: твой id в системе и токен, который ты будешь использовать для авторизации. Сохрани их куда-нибудь, чтобы не потерять

Get token

Данный токен поможет сервису понять, кто ты. Благодаря нему тебе не придется передавать email / пароль при каждом запросе, а твои фото и прочая информация будут загружены в правильное место.

Пример использования токена

fetch("https://c-gallery.polinashneider.space/api/v1/posts/", {
    method: "POST",
    body: <тело запроса>,
    headers: {
      Authorization:
        "Bearer <тут твой токен>",
    },
  })

Как работать со Swagger

Swagger — это что-то вроде наглядной документации по бэкенду.

Благодаря нему, ты сможешь легко понять, данные в каком формате отправлять по какому адресу и что ожидать в ответ.

Давай сразу к делу. Swagger проекта находится по адресу

https://c-gallery.polinashneider.space/swagger/

Посмотрим, что находится внутри

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

Endpoints

Слева у каждого адреса написан тип запроса. GET и POST тебе уже известны, а вот с PATCH, PUT и DELETE только предстоит еще познакомиться.

Здесь указаны лишь относительные адреса. Полный адрес для /posts/ будет

https://c-gallery.polinashneider.space/api/v1/posts/

То есть добавятся протокол, домен, а также префикс /api/v1/

Важно! В конце запроса должен присутствовать слеш

Чтобы посмотреть, что ожидает тот или иной эндпойнт в теле запроса, нужно открыть вкладку Example Value в Parameters

Request

Формат возвращаемых данных можно узнать в Example Value в Responses

Request

Довольно удобная документация для взаимодействия с бэкендом, не правда ли? 😊

Отправка запросов из Swagger

Но это еще не все. У тебя есть возможность отправлять запросы прямо из сваггера под своим пользователем и смотреть на реакцию бэкенда именно на твой запрос.

Чтобы авторизоваться в сваггере, в правом верхнем углу кликни на кнопку логина

Login

Далее введи туда свой токен в формате

Bearer <токен>

Token

Теперь ты авторизована и можешь выполнять запросы.

Давай получим данные о текущем пользователе с помощью GET-запроса /users/me/

Чтобы это сделать, нажми на кнопку Try it out и следом — Execute

Execute

Ты увидишь данные именно о твоем пользователе. Некоторая информация предзаполнена, а email будет твой (который ты указывала при регистрации)

Data