Руководство по интеграции API DevKG

Введение

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

Базовый URL

Базовый URL для всех API-запросов:

http://3.38.98.134

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

Для получения подробной информации о спецификациях API вы можете обратиться к официальной документации:

• Документация API: Документация API сервера Piccolo

Аутентификация

Регистрация

Для регистрации нового пользователя:

• Конечная точка: POST /auth/signup
• Описание: Создает новую учетную запись пользователя.
• Тело запроса:

  {
    "username": "string",
    "password": "string"
  }

• Ответ: Возвращает данные пользователя или сообщение об ошибке.

Вход

Для аутентификации пользователя:

• Конечная точка: POST /auth/login
• Описание: Вход пользователя с именем пользователя и паролем.
• Тело запроса:

  {
    "username": "string",
    "password": "string"
  }

• Ответ: Возвращает токен аутентификации или сообщение об ошибке.

События

Получить все события

• Конечная точка: GET /events
• Описание: Возвращает список всех событий.

Создать событие

• Конечная точка: POST /events
• Описание: Создает новое событие.
• Тело запроса:

  {
    "title": "string",
    "description": "string",
    "date": "string"
  }

Получить событие по ID

• Конечная точка: GET /events/{id}
• Описание: Возвращает детали конкретного события по ID.

Обновить событие

• Конечная точка: PATCH /events/{id}
• Описание: Обновляет существующее событие.
• Тело запроса:

  {
    "title": "string",
    "description": "string",
    "date": "string"
  }

Удалить событие

• Конечная точка: DELETE /events/{id}
• Описание: Удаляет конкретное событие по ID.

Сбросить события

• Конечная точка: POST /events/reset
• Описание: Удаляет все события.

Слова

Получить слова

• Конечная точка: GET /words
• Описание: Возвращает список всех возможных слов длиной в 5 символов.

Вакансии

Получить все вакансии

• Конечная точка: GET /jobs
• Описание: Возвращает список всех вакансий.

Создать вакансию

• Конечная точка: POST /jobs
• Описание: Создает новую вакансию.
• Тело запроса:

  {
    "title": "string",
    "company": "string",
    "location": "string",
    "description": "string"
  }

Получить вакансию по ID

• Конечная точка: GET /jobs/{id}
• Описание: Возвращает детали конкретной вакансии по ID.

Обновить вакансию

• Конечная точка: PATCH /jobs/{id}
• Описание: Обновляет существующую вакансию.
• Тело запроса:

  {
    "title": "string",
    "company": "string",
    "location": "string",
    "description": "string"
  }

Удалить вакансию

• Конечная точка: DELETE /jobs/{id}
• Описание: Удаляет конкретную вакансию по ID.

Сбросить вакансии

• Конечная точка: POST /jobs/reset
• Описание: Удаляет все вакансии.

Встречи

Получить все встречи

• Конечная точка: GET /meetups
• Описание: Возвращает список всех встреч.

Создать встречу

• Конечная точка: POST /meetups
• Описание: Создает новую встречу.
• Тело запроса:

  {
    "title": "string",
    "description": "string",
    "date": "string"
  }

Получить встречу по ID

• Конечная точка: GET /meetups/{id}
• Описание: Возвращает детали конкретной встречи по ID.

Обновить встречу

• Конечная точка: PATCH /meetups/{id}
• Описание: Обновляет существующую встречу.
• Тело запроса:

  {
    "title": "string",
    "description": "string",
    "date": "string"
  }

Удалить встречу

• Конечная точка: DELETE /meetups/{id}
• Описание: Удаляет конкретную встречу по ID.

Сбросить встречи

• Конечная точка: POST /meetups/reset
• Описание: Удаляет все встречи.

Организации

Получить все организации

• Конечная точка: GET /organizations
• Описание: Возвращает список всех организаций.

Создать организацию

• Конечная точка: POST /organizations
• Описание: Создает новую организацию.
• Тело запроса:

  {
    "name": "string",
    "description": "string",
    "location": "string"
  }

Получить организацию по ID

• Конечная точка: GET /organizations/{id}
• Описание: Возвращает детали конкретной организации по ID.

Обновить организацию

• Конечная точка: PATCH /organizations/{id}
• Описание: Обновляет существующую организацию.
• Тело запроса:

  {
    "name": "string",
    "description": "string",
    "location": "string"
  }

Удалить организацию

• Конечная точка: DELETE /organizations/{id}
• Описание: Удаляет конкретную организацию по ID.

Сбросить организации

• Конечная точка: POST /organizations/reset
• Описание: Удаляет все организации.

Сообщество

Получить все записи сообщества

• Конечная точка: GET /community
• Описание: Возвращает список всех записей сообщества.

Создать запись сообщества

• Конечная точка: POST /community
• Описание: Создает новую запись сообщества.
• Тело запроса:

  {
    "title": "string",
    "description": "string"
  }

Получить запись сообщества по ID

• Конечная точка: GET /community/{id}
• Описание: Возвращает детали конкретной записи сообщества по ID.

Обновить запись сообщества

• Конечная точка: PATCH /community/{id}
• Описание: Обновляет существующую запись сообщества.
• Тело запроса:

  {
    "title": "string",
    "description": "string"
  }

Удалить запись сообщества

• Конечная точка: DELETE /community/{id}
• Описание: Удаляет конкретную запись сообщества по ID.

Сбросить записи сообщества

• Конечная точка: POST /community/reset
• Описание: Удаляет все записи сообщества.

Начало работы

Чтобы начать использовать API DevKG:

1. Аутентификация: Используйте конечные точки /auth/signup и /auth/login для создания учетной записи и входа в систему.
2. Выполнение запросов к API: Используйте различные доступные конечные точки для взаимодействия с событиями, вакансиями, встречами, организациями и записями сообщества.
3. Сброс данных: Используйте конечные точки сброса для очистки всех данных при необходимости.

Пример

Чтобы получить все