Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 809 Bytes

README.md

File metadata and controls

26 lines (18 loc) · 809 Bytes

API template project suppose to be used as a starter for a new service development.
Current template includes:

Logger

Zap package is used for logger implementation

Open API

Swag is used for an Open API in composition with HTTP Swagger which helps to integrate with native net/http GO package.

In order to generate or update docs for Open API documentation it needs to run command (from the root):

make swag-init

Endpoints available in the template:

  • /status (it will be visible in Swagger)

Swagger url (port may be altered):

http://localhost:8080/swagger/index.html

Web API Router

Mux is used as a router for a web API