https://github.com/dropdevrahul/simple-api
https://github.com/dropdevrahul/simple-api
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dropdevrahul/simple-api
- Owner: dropdevrahul
- Created: 2023-03-23T05:34:02.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-07T15:50:58.000Z (almost 3 years ago)
- Last Synced: 2024-06-21T00:17:53.091Z (over 1 year ago)
- Language: Go
- Size: 42 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Go API
A simple go API with minimum dependencies and postgres integration
## Dependencies
- Database
- [sqlx](https://github.com/jmoiron/sqlx) to connect to db
- [goose](https://github.com/pressly/goose) for migration
- [lib-pq](https://github.com/lib/pq) as database driver
- Configuration
- [viper](https://github.com/spf13/viper) for configuration
- Router
- [chi](https://github.com/go-chi/chi) as router
- API Docs
- [swag](https://github.com/swaggo/swag#getting-started) helps generating swagger from docs as well as serve swagger UI from within the API using any popular routers
## Makefile
Please see the makefile for available commands.
- To generate swagger API use the make command `make gen-swagger` then run `make run` and go to [localhost](http://localhost:9090/swagger/index.html) to see
the generated swagger docs