mif

command module
v0.0.0-...-4231655 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 30, 2018 License: MIT Imports: 7 Imported by: 0

README

Go Report Card Build Status Contributions Welcome

Важно! Этот проект находится в архивном состоянии и не следует некоторым лучшим практикам, которые имеет смысл рассматривать при разаботке сервисов на Go. Если вы хотите узнать побольше о лучших практиках написания сервисов на Go, пожалуйста, ознакомьтесь с докладом Best Practices for Cloud Native Go Services или другими подходящими источниками.

Этот репозиторий представляет собой реализацию неофициального REST API для книг издательства «МИФ».

Всё написано на Go.

Текущая версия является пробной и нестабильной, в будущем возможны изменения, не являющиеся обратно совместимыми. Если вы хотите застраховать себя от таких изменений, пожалуйста, используйте фиксированные теги.

Вклад в проект посредством создания issues и pull requests приветствуется 🤓

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

БД

Используется БД PostgreSQL.

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

Структура данных

Можно воспользоваться готовым дампом из db или задать структуру базы данных, используя нижеследующее описание. В случае развертывания сервиса из Docker-образов (см. инструкцию ниже), дамп базы накатывается автоматически.

База данных
CREATE DATABASE mifbooks WITH TEMPLATE = template0 ENCODING = 'UTF8' LC_COLLATE = 'en_US.utf8' LC_CTYPE = 'en_US.utf8';
Необходимые таблицы
CREATE TABLE IF NOT EXISTS categories (
  id SERIAL PRIMARY KEY,
  title VARCHAR(256) NOT NULL,
  created_at TIMESTAMP WITHOUT TIME ZONE NOT NULL,
  updated_at TIMESTAMP WITHOUT TIME ZONE NOT NULL
);

CREATE TABLE IF NOT EXISTS books (
  id SERIAL PRIMARY KEY,
  mif_id INTEGER,
  category_id INTEGER,
  title VARCHAR(512),
  isbn VARCHAR(64),
  authors VARCHAR(512),
  url VARCHAR(512) UNIQUE NOT NULL,
  created_at TIMESTAMP WITHOUT TIME ZONE NOT NULL,
  updated_at TIMESTAMP WITHOUT TIME ZONE NOT NULL,
  is_visible BOOLEAN DEFAULT NULL
);

CREATE TABLE IF NOT EXISTS books_broken (
  id SERIAL PRIMARY KEY,
  url VARCHAR(512) UNIQUE NOT NULL,
  created_at TIMESTAMP WITHOUT TIME ZONE NOT NULL,
  updated_at TIMESTAMP WITHOUT TIME ZONE NOT NULL
);

CREATE TYPE volume_type AS ENUM ('paperbook', 'ebook', 'audiobook');
CREATE TABLE IF NOT EXISTS volumes (
  id SERIAL PRIMARY KEY,
  book_id INTEGER NOT NULL REFERENCES books(id),
  type volume_type NOT NULL,
  created_at TIMESTAMP WITHOUT TIME ZONE NOT NULL,
  updated_at TIMESTAMP WITHOUT TIME ZONE NOT NULL,
  
  UNIQUE (book_id, type)
);

 CREATE TABLE IF NOT EXISTS users (
  id SERIAL PRIMARY KEY,
  email VARCHAR(128) UNIQUE NOT NULL,
  token VARCHAR(128) UNIQUE NOT NULL,
  created_at TIMESTAMP WITHOUT TIME ZONE NOT NULL,
  updated_at TIMESTAMP WITHOUT TIME ZONE NOT NULL
 );
 
 CREATE TABLE IF NOT EXISTS library (
   id SERIAL PRIMARY KEY,
   user_id INTEGER NOT NULL REFERENCES users(id),
   volume_id INTEGER NOT NULL REFERENCES volumes(id),
   created_at TIMESTAMP WITHOUT TIME ZONE NOT NULL,
   updated_at TIMESTAMP WITHOUT TIME ZONE NOT NULL,
   
   UNIQUE (user_id, volume_id)
 );

Импорт данных

Импорт данных на текущий момент предполагается в полуручном режиме: все предлагаемые команды можно запускать или вручную, или добавить их в расписание планировщика задач (cron) для регулярного запуска.

Подробности - в data

Запуск сервера

Пример запуска с помощью Docker'а

Самый простой способ поднять сервер с API. В этом случае из DockerHub'а будут подтянуты уже существующие образы с БД и приложением.

docker-compose up

Запуск сервера занимает ~10-15 секунд (время раската дампа БД). После этого сразу можно делать запросы к API. По умолчанию сервер слушает порт 80. Для проверки работоспособности можно попробовать запрос http://127.0.0.1/api/v1/books. Альтернативную конфигурацию можно задать в файле docker-compose.yml.

Для сборки и отправки образов используется скрипт make.sh, при желании его можно кастомизировать в своих целях.

Пример "сырого" запуска сервера API

В этом случае будет произведен запуск приложения с использованием go run (полезно для отладки).

env HOST=127.0.0.1 PORT=80 \
DB_HOST=localhost DB_PORT=5432 DB_USER=postgres DB_PASS=mysecretpassword DB=mifbooks \
go run mif.go --debug

Параметры host и port отвечают за то, по какому адресу и порту слушать запросы. Параметры с префиксом db_ задают конфигурацию доступа к БД PostgreSQL: хост, порт, пользователь, пароль, название БД.

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

Все книги издательства

Список книг

GET /api/v1/books - получить список книг издательства. В выдаче книги будут отсортированы по id в обратном порядке: от более новых к более старым.

Опциональные параметры запроса:

  • search - поиск книги по части названия

  • author - поиск книги по автору

  • mif_id - поиск книги по идентификатору в МИФ

  • type - тип "носителя" книги: paperbook, ebook, audiobook

  • limit - "пагинация": кол-во записей на странице (по умолчанию 10)

  • offset - "пагинация": сдвиг записей (по умолчанию 0)

Пример запроса:

curl -X GET http://mif.grahovac.me/api/v1/books?search=маркетинг&limit=50
Информация о книге

GET /api/v1/books/:id - получить конкретную книгу по ее идентификатору в БД

Пример запроса:

curl -X GET http://mif.grahovac.me/api/v1/books/33

Личная библиотека

Запросы к личной библиотеке подразумевают аутентификацию пользователя. Для аутентификации используется секретный токен, передаваемый через параметр запроса token.

В случае, если запрос предполагает наличие тела запроса, оно передается в формате JSON.

Список книг

GET /api/v1/library - получить список книг, имеющихся в собственной библиотеке. В выдаче книги будут отсортированы по id в обратном порядке: добавленные последними будут в начале выдачи.

Обязательные параметры запроса:

  • token - уникальный токен пользователя для аутентификации

Опциональные параметры запроса:

  • limit - "пагинация": кол-во записей на странице (по умолчанию 10)
  • offset - "пагинация": сдвиг записей (по умолчанию 0)

Пример запроса:

curl -X GET http://mif.grahovac.me/api/v1/library?token=6f9c1a78-36c7-4703-adb7-e0101e480c64&limit=50
Добавить книгу в свою библиотеку

POST /api/v1/library

Обязательные параметры запроса:

  • token - уникальный токен пользователя для аутентификации

Обязательные параметры тела запроса:

  • book_id - идентификатор добавляемой книги
  • type - "носитель" добавляемой книги: paperbook, ebook, audiobook

Пример запроса:

curl -X POST http://mif.grahovac.me/api/v1/library?token=6f9c1a78-36c7-4703-adb7-e0101e480c64 \
-H 'Content-Type: application/json' \
-d '{"book_id": 33, "type": "paperbook"}'
Удалить книгу из своей библиотеки

DELETE /api/v1/library

Обязательные параметры запроса:

  • token - уникальный токен пользователя для аутентификации

Обязательные параметры тела запроса:

  • book_id - идентификатор добавляемой книги
  • type - "носитель" добавляемой книги: paperbook, ebook, audiobook.

Пример запроса:

curl -X DELETE http://mif.grahovac.me/api/v1/library?token=6f9c1a78-36c7-4703-adb7-e0101e480c64 \
-H 'Content-Type: application/json' \
-d '{"book_id": 33, "type": "paperbook"}'

Road map

  • Тесты!
  • Добавить клиента для API и консольное приложение для работы с ним
  • Добавить swagger-документацию для API
  • Рефакторинг кишков middleware (запросы к БД)
  • Актуализировать Makefile набором полезных команд
  • Поддержка HTTPS
  • Запуск импорта данных по расписанию
  • Утилита для управления пользователями

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

View all Source files

Directories

Path Synopsis
data
import
link-list
save
update

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.