API - Vedji/comics_server GitHub Wiki

Информация о API

Оглавление

  1. Основные Сведения
  2. Аутентификация
  3. Эндпоинты

Основные Сведения

  • Название API: comics server api
  • Версия API: 1.0.1
  • Хост: localhost
  • Базовый URL: 127.0.0.1:5000

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

Для доступа к API необходима аутентификация. Используйте следующие параметры:

  • Тип аутентификации: API ключ
  • Имя заголовка: Authorization
  • Формат ключа: Bearer <ваш_токен>

Эндпоинты

Эндпоинт 1: Получение списка произведений

  • URL: /api/v1/work

  • Метод: GET

  • Авторизация: Нет

  • Параметры запроса:

    • limit (int) - Лимит получаемых записей
    • offset (int) - Сдвиг получаемых записей
    • search_name (string) - название произведения, будут выданы только те, в которых присутствует эта строка
    • genre (string)- Строка жанров

  • Пример запроса: GET http://127.0.0.1:5000/api/v1/work?limit=10&offset=20&genre=___1____________&search_name=man

    • Ответ:
    • 200 OK - успешный запрос
    • 404 Not Found - запись не найдена
    • 400 Bad Request - некорректные аргументы

Эндпоинт 2: Добавление нового произведения

  • URL: /api/v1/work

  • Метод: POST

  • Авторизация: Да

  • Тело запроса:

    • work_id - ID добавляемого произведения
    • ru_name - Название добавляемого произведения
    • desc (string) - Описание произведения
    • genre (string) - Строка жанров произведения
    • pre_img (file) - Файл для загрузки

  • Пример запроса: POST http://127.0.0.1:5000/api/v1/work Content-Type: multipart/form-data

  • Ответ:

    • 201 Created - данные успешно загружены
    • 400 Bad Request - ошибка в запросе
    • 401 Unauthorized - ошибка авторизации

Эндпоинт 3: Получение информации о произведении

  • URL: /api/v1/work/<work_id>

  • Метод: GET

  • Авторизация: Нет

  • Параметры запроса:

    • <work_id> - ID произведения

  • Пример запроса: GET http://127.0.0.1:5000/api/v1/work/Mandy

    • Ответ:
    • 200 OK - успешный запрос
    • 404 Not Found - запись не найдена
    • 400 Bad Request - некорректные аргументы

Эндпоинт 4: Получение списка глав произведения

  • URL: /api/v1/work/<work_id>/chapter

  • Метод: GET

  • Авторизация: Нет

  • Параметры запроса:

    • <work_id> - ID произведения

  • Пример запроса: GET http://127.0.0.1:5000/api/v1/work/Mandy/chapter

  • Ответ:

    • 200 OK - успешный запрос
    • 404 Not Found - запись не найдена
    • 400 Bad Request - некорректные аргументы

Эндпоинт 5: Добавление нового произведения

  • URL: /api/v1/work/<work_id>/chapter

  • Метод: POST

  • Авторизация: Да

  • Тело запроса:

    • <work_id> - ID добавляемого произведения
    • chapter_name - Название главы
    • chapter_num (string) - Номер главы в произведении
    • count_files (string) - Количество загружаемых файлов
    • pre_img (files) - Список файлов

  • Пример запроса: POST http://127.0.0.1:5000/api/v1/work/Mandy/chapter Content-Type: multipart/form-data

  • Ответ:

    • 200 OK - Запись создана
    • 400 Bad Request - ошибка в запросе
    • 401 Unauthorized - ошибка авторизации

Эндпоинт 6: Получение списка комментариев произведения

  • URL: /api/v1/work/<work_id>/comments

  • Метод: GET

  • Авторизация: Нет

  • Параметры запроса:

    • <work_id> - ID произведения
    • limit (int) - Лимит получаемых записей
    • offset (int) - Сдвиг получаемых записей
    • but_user_id - Кроме, пользователя

  • Пример запроса: GET http://127.0.0.1:5000/api/v1/work/Mandy/comments

  • Ответ:

    • 200 OK - успешный запрос
    • 404 Not Found - запись не найдена
    • 400 Bad Request - некорректные аргументы

Эндпоинт 7: Получение среднего значения рейтинга произведения

  • URL: /api/v1/work/<work_id>/rating

  • Метод: GET

  • Авторизация: Нет

  • Параметры запроса:

    • <work_id> - ID произведения

  • Пример запроса: GET http://127.0.0.1:5000/api/v1/work/Mandy/rating

  • Ответ:

    • 200 OK - успешный запрос
    • 404 Not Found - запись не найдена
    • 400 Bad Request - некорректные аргументы

Эндпоинт 8: Удаление произведения

  • URL: /api/v1/work/<work_id>

  • Метод: DELETE

  • Авторизация: Да

  • Параметры запроса:

    • <work_id> - ID произведения

  • Пример запроса: GET http://127.0.0.1:5000/api/v1/work/mandy

  • Ответ:

    • 200 OK - успешный запрос
    • 404 Not Found - запись не найдена
    • 400 Bad Request - некорректные аргументы
    • 401 Unauthorized - ошибка авторизации
⚠️ **GitHub.com Fallback** ⚠️