Giter VIP home page Giter VIP logo

echo-rest-api's Introduction

echo-rest-api

В данном проекте показан пример создания REST API на Go с использованием Echo framework.

В проекте использованы

HTTP

  • 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 - в качестве СУБД использовалась postgresql
  • github.com/rubenv/sql-migrate - миграционная тулза для sql
  • docker postgres image - для запуска postgresql

Конфигурация

  • flag - для передачи параметров при запуске
  • github.com/jinzhu/configor - для загрузки конфигурации из yaml

Логгирование

  • github.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

echo-rest-api's People

Contributors

onakrainikoff avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.