ocp-presentation-api

module

v0.0.0-...-23b1354 Latest Latest Go to latest Published: Jul 2, 2021 License: MIT

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ozoncp/ocp-presentation-api

Links

Open Source Insights

README ¶

Ozon Code Platform Presentation API

Ozon Code Platform Presentation API is a service that provides API to access/manage Presentation and Slide entities.

Go Generated Code

make requirements
make dependencies
make vendor-proto
make generate

swagger-ui

Download

docker pull swaggerapi/swagger-ui

Run

On Unix

docker run -d -p 80:8080 -e BASE_URL=/swagger -e SWAGGER_JSON=/swagger/api.swagger.json -v `pwd`/swagger:/swagger swaggerapi/swagger-ui

On Windows

docker run -d -p 80:8080 -e BASE_URL=/swagger -e SWAGGER_JSON=/swagger/api.swagger.json -v %cd%/swagger:/swagger swaggerapi/swagger-ui

grpcui

grpcui -proto ./api/ocp-presentation-api/ocp-presentation-api.proto -import-path ./vendor.protogen -plaintext -open-browser localhost:8000

docker-compose

docker-compose pull

docker-compose run ocp-presentation-api

docker-compose up -d
docker-compose build
docker-compose up --build

docker-compose ps
docker logs --follow ocp-presentation-api_web_1

docker-compose stop
docker-compose down --volumes

prometheus

Jaeger UI

Directories ¶

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

Path	Synopsis
cmd
ocp-presentation-api
ocp-slide-api
internal
common/alarm Package alarm implements a simple internal library for Ozon Code Platform Presentation API.	Package alarm implements a simple internal library for Ozon Code Platform Presentation API.
common/clockwrapper Package clockwrapper implements a simple internal library for Ozon Code Platform Presentation API.	Package clockwrapper implements a simple internal library for Ozon Code Platform Presentation API.
ocp-presentation-api/api Package api implements a simple API for Ozon Code Platform Presentation API.	Package api implements a simple API for Ozon Code Platform Presentation API.
ocp-presentation-api/flusher Package flusher synchronizes the associated repository with data.	Package flusher synchronizes the associated repository with data.
ocp-presentation-api/mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.
ocp-presentation-api/model Package model represents model data for Ozon Code Platform Presentation API.	Package model represents model data for Ozon Code Platform Presentation API.
ocp-presentation-api/repo Package repo saves data into the database.	Package repo saves data into the database.
ocp-presentation-api/saver Package saver flushes presentations by the time.	Package saver flushes presentations by the time.
ocp-slide-api/api Package api implements a simple API for Ozon Code Platform Slide API.	Package api implements a simple API for Ozon Code Platform Slide API.
ocp-slide-api/flusher Package flusher synchronizes the associated repository with data.	Package flusher synchronizes the associated repository with data.
ocp-slide-api/mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.
ocp-slide-api/model Package model represents model data for Ozon Code Platform Presentation API.	Package model represents model data for Ozon Code Platform Presentation API.
ocp-slide-api/repo Package repo saves data into the database.	Package repo saves data into the database.
ocp-slide-api/saver Package saver flushes slides by the time.	Package saver flushes slides by the time.
pkg
ocp-presentation-api Package ocp_presentation_api is a reverse proxy.	Package ocp_presentation_api is a reverse proxy.
ocp-slide-api Package ocp_slide_api is a reverse proxy.	Package ocp_slide_api is a reverse proxy.