ova-journey-api

module
v0.0.0-...-eb5cc7f Latest Latest
Warning

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

Go to latest
Published: Sep 8, 2021 License: MIT

README

Journeys API for Ozon Voice Assistant project

GitHub go.mod Go version of a Go module Go Report Card GitHub license GitHub pull-requests

Ozon Voice Assistant Project Documentation is here https://github.com/ozonva/docs

Services

API
GRPC

http://localhost:8081

JSON Gateway

http://localhost:8080

Metrics for Prometheus

http://localhost:9100/metrics

HealthChecker

http://localhost:9101/health

With UI
Swagger UI

http://localhost:8080

Jaeger UI

http://localhost:16686

Kafka UI

http://localhost:8082

Prometheus UI

http://localhost:9090

Graylog UI

http://localhost:9000

Commands

  • make all - clean from binary builds, run all tests and linters, then build the application with code generation
  • make run- run the application
  • make build - build the application into bin directory
  • make deps - install all project dependencies
  • make bin-deps - install binary tools (mockgen, proto generators) into bin directory
  • make clean - clean from binary builds, delete bin directory
  • make lint - check code by golangci-lint and gosec linters
  • make vendor-proto - download external proto files (Google)
  • make generate - use code generation
  • make test - run all tests
  • make documentation - make documentation and run documentation server on http://localhost:6060/pkg/github.com/ozonva/ova-journey-api/?m=all
  • make docker-build - build docker application environment using docker-compose

Directories

Path Synopsis
cmd
ova-journey-api
Journeys API (gRPC + JSON gateway) for Ozon Voice Assistant project Ozon Voice Assistant Project Documentation is here https://github.com/ozonva/docs
Journeys API (gRPC + JSON gateway) for Ozon Voice Assistant project Ozon Voice Assistant Project Documentation is here https://github.com/ozonva/docs
api
mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
pkg
ova-journey-api
Package ova_journey_api is a reverse proxy.
Package ova_journey_api is a reverse proxy.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL