Full stack проект на Go за неделю

Этой серией постов мы охватим создание full stack проекта на языке Go (golang).

Наш проект: Конвертер валют

Из названия в принципе понятно, что будет делать приложение — конвертация валют. Реальное, полезное, удобное приложение — что ещё нужно для хорошего примера?

Мы разделим приложение на отдельные части, дабы проще уместить проект в серию статей и постепенно наращивать сложность.

• День 1: Определяемся с бэкендом и API (вы читаете его)
• День 2: Разработка бэкенд-сервера
• День 3: Тестируем бэкенд
• День 4: Запускаем бэкенд
• День 5: Настраиваем CI/CD
• День 6: Настраиваем мониторинг, пишем документацию

День первый. Определяемся с бэкендом и API

Сегодня мы должны определиться с тем, что мы хотим от нашего приложения и API, какие технологии используем для его построения и т.д. С этим фундаментом мы и начнём реализацию.

Главная идея сервиса — предоставить API для массовой конвертации сумм в разных валютах. Кроме того, мы создадим систему настройки веб-хуков для оповещений об изменении курса валют.
Для веб-сайта и мобильных приложений нам нужен способ получения всех курсов валют (во фронтенде будет происходить расчёт и конвертация) и способ получения истории изменения курса каждой валюты.

Получение валют

Первая проблема — где брать актуальные курсы валют. На самом деле проблем с валютами намного больше: это и разница между курсами покупки/продажи, это и отношение курсов между разными валютами, и т.д., но мы не будем сейчас вдаваться в детали — нам просто нужен достоверный источник актуальных курсов валют.

И Европейский Центральный Банк (ECB) как раз предоставляет курсы валют в формате XML со своих серверов. XML файл мы можем получить через HTTP и это полностью нас устраивает на данный момент. В ECB нет курсов всех валют мира, но сейчас для нас это также не имеет значения.

Их XML файл выглядит следующим образом:



Reference rates

European Central Bank





































Структура файла предельно проста — он содержит даже дату курсов. Единственное, чего не хватает, это полного названия валют. Но это мы поправим в своём приложении.

Мы можем получать курсы валют по HTTP раз в день, в принципе, этого будет достаточно. Но было бы желательно сделать вариант загрузки курсов с учётом временных зон и настраиваемой частотой загрузки — возможно, даже раз в час.

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

Всё это будет выполняться скриптом в фоне — это не часть бэкенда, с которой кто-нибудь будет работать напрямую, оно просто должно работать когда нужно.

API

Здесь мы опишем, что хотим от API. В первую очередь, все конечные точки должны возвращать данные в формате JSON.

/currencies GET, POST

Эта конечная точка возвратит JSON-представление всех валют. При GET-запросе будут получены данные относительно базовой валюты (EUR), а запрос POST будет принимать параметр с наименованием базовой валюты, после чего будет проведён соответствующий расчёт.

Содержание POST-запроса с передачей базовой валюты Британского фунта будет таким:

{
"base_currency": "GBP"
}
Ответ сервера и на POST и на GET запросы будет следующим:

{
"currency_date": "2016-04-01",
"base_currency": "GBP",
"rates": [
{
"name": "USD",
"rate": 1,43097
},
{
"name": "DKK",
"rate": 9,32570
},
...
]
}

/convert POST

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

{
"target_currency": "USD",
"base_currency": "GBP",
"amounts": [
14,
9,
4.3125,
5.5,
...
]
}
В ответе будет сохранён такой же порядок сумм:

{
"base_currency": "GBP",
"target_currency": "USD",
"currency_date": "2016-04-01",
"converted_amounts": [
9.783590,
6.289451,
3.013695,
3.843553,
...
]
}

/webhook POST, DELETE

С помощью этой конечной точки мы будем добавлять и удалять веб-хуки. При её вызове необходимо учитывать, что переданный URL способен принимать POST-запрос и отвечать в JSON.
POST-запрос будет примерно таким:

{
"base_currency": "USD",
"url": "http://some.exampleserver.foo/currency/webhook",
"token": "somemagickeyword"
}
При добавлении новых курсов, бэкенд выполнит POST-запрос на этот URL, в котором будет необходимый курс валюты и дополнительный заголовок Authorization с настроенным токеном (для безопасности, чтобы никто посторонний не мог делать POST-запросы на этот URL).

Что дальше?

Программирование!

Далее мы выберем среду разработки и стек для деплоя, затем примемся за разработку.

Второй день