certusone
/
wormhole-explorer
mirror of https://github.com/certusone/wormhole-explorer.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
wormhole-explorer/api
History
gipsh 085d5ecd03
add swagger doc, makefile and readme (#53) 
Co-authored-by: gipsh <gipsh@gmail.com>
 		2023-01-10 12:32:07 -03:00
..
docs add swagger doc, makefile and readme (#53) 2023-01-10 12:32:07 -03:00
handlers add swagger doc, makefile and readme (#53) 2023-01-10 12:32:07 -03:00
internal 18 fly api cache most recent data for most frequent queries (#51) 2023-01-05 16:40:24 -03:00
middleware Feature/refactor api (#34) 2022-11-23 09:06:29 -03:00
response Add grpc api (#40) 2023-01-03 14:42:29 -03:00
Dockerfile Add k8s deployment (#39) 2022-12-14 17:07:55 -03:00
Makefile add swagger doc, makefile and readme (#53) 2023-01-10 12:32:07 -03:00
README.md add swagger doc, makefile and readme (#53) 2023-01-10 12:32:07 -03:00
go.mod 18 fly api cache most recent data for most frequent queries (#51) 2023-01-05 16:40:24 -03:00
go.sum 18 fly api cache most recent data for most frequent queries (#51) 2023-01-05 16:40:24 -03:00
main.go add swagger doc, makefile and readme (#53) 2023-01-10 12:32:07 -03:00

README.md

API

How to build

make build

Config

You will need to set some env variables with the prefix WORMSCAN

  • WORMSCAN_DB_MONGO
  • WORMSCAN_DB_NAME
  • WORMSCAN_PORT

for example:

WORMSCAN_DB_URL=mongodb://localhost:27017/wormhole WORMSCAN_PORT=5555 ./api

API Documentation

Documentation is automagically generated via swaggo using annotations on code and placed inside doc/ folder.

To install swag tool run this

go install github.com/swaggo/swag/cmd/swag@latest

To generate or update the doc run:

make doc