Skip to content

Latest commit

 

History

History
43 lines (31 loc) · 902 Bytes

README.md

File metadata and controls

43 lines (31 loc) · 902 Bytes
Raw

Overview

This project is intended to be used as web server template development.

The work currently is in progress to create more organized template

Prerequisites

- Go Language Installed

How to run the services

Windows

- go build cmd\main.go
- go run cmd\main.go

Linux

- go build cmd/main.go
- go run cmd/main.go

How to access Swagger

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

How to renew Swagger description

Usually the swagger would be updated to latest. However if you need to do some development and changing the API, you need to update the swagger again. Make sure you already have swag by using 
go install github.com/swaggo/swag/cmd/swag@latest

and then you can run:

Windows

  • swag i -g pkg\api\api_v1.go --instanceName v1

Linux

  • swag i -g pkg/api/api_v1.go --instanceName v1