Example of creating REST API with Echo framework
В данном проекте показан пример создания REST API на Go с использованием Echo framework.
github.com/labstack/echo
- для создания rest сервиса; использованы: router, data binding и data rendering, logger middleware
gopkg.in/go-playground/validator.v9
- для data validation
database/sql
- для работы с запросами и транзакционностьюgithub.com/lib/pq
- в качестве СУБД использовалась postgresqlgithub.com/rubenv/sql-migrate
- миграционная тулза для sqldocker postgres image
- для запуска postgresqlflag
- для передачи параметров при запускеgithub.com/jinzhu/configor
- для загрузки конфигурации из yamlgithub.com/sirupsen/logrus
- для логов приложенияtesting
- для написания тестовgithub.com/golang/mock/gomock
- для генерации моковgithub.com/stretchr/testify/assert
- исключительно для assert в тестахgithub.com/golang/dep
- менеджер зависимостей
make init
- установит необходимые тулзы (dep, sql-migrate, mockgen), затем через dep
установит зависимости проектаmake run
- запустит приложение, при этом запустив docker контейнер с БДmake test
- запустит приложение, при этом запустив docker контейнер с БДmake spec
- сгенерирует open-api спецификацию в spec/api.json.
После запуска сервис отдает спеку как статику по пути /spec/api.json, можно также выполнить swagger serve -F=swagger http://localhost:8081/spec/api.json
, что бы отобразить в html виде c запущенного сервиса.spec-ui
- откроет спеку в html