https://github.com/idoqo/esquina
Go-powered API for an online catalog.
https://github.com/idoqo/esquina
Last synced: 4 months ago
JSON representation
Go-powered API for an online catalog.
- Host: GitHub
- URL: https://github.com/idoqo/esquina
- Owner: idoqo
- Created: 2020-05-10T10:22:41.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-12T08:02:39.000Z (about 5 years ago)
- Last Synced: 2023-03-06T11:12:41.143Z (over 2 years ago)
- Language: Go
- Homepage:
- Size: 6.84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### Intro
This is a basic backend API for Esquina, a fictional, minimalist app that lets you
showcase your business to customers in the most glorious of ways.
Alternatively, it is a prototype API to figure out the pros and cons of
go-swagger and swaggo - The two major packages for working with OpenAPI in Golang.
### Core Dependencies
- [go-chi/chi](github.com/go-chi/chi) (for API routing).
- [rs/cors](github.com/rs/cors) (for Handling CORS).
- [goswagger](https://goswagger.io) (for code-first documentation).
- [swaggo/swag](github.com/swaggo/swag) (go-swagger alternative because, choices).
### Requirements
Go - v1.13
### App Setup
* Clone this repository
```bash
$ git clone https://github.com/idoqo/esquina
```
* Enter the project directory with:
```
$ cd esquina
```
* Execute the `main.go` file with:
```
$ go run main.go
```
### Tests
Unit and integration tests are written using the testing library built into go.
Run them with:
```
go test
```
### Resources
- Tour of Go
- Moira API source
- OpenAPI
### Documentation
The API documentation is an Open API description powered by go-swagger.
You can view it at: http://abeg-rest.haq