Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mramshaw/simple-rest-api
A proof of concept of a simple REST API in Golang. All data is held in memory, all transfer is via JSON. CORS is handled.
https://github.com/mramshaw/simple-rest-api
cors go golang json rest rest-api swagger
Last synced: 8 days ago
JSON representation
A proof of concept of a simple REST API in Golang. All data is held in memory, all transfer is via JSON. CORS is handled.
- Host: GitHub
- URL: https://github.com/mramshaw/simple-rest-api
- Owner: mramshaw
- Created: 2017-07-16T17:09:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-03-06T17:30:17.000Z (almost 5 years ago)
- Last Synced: 2024-12-21T04:34:05.677Z (about 1 month ago)
- Topics: cors, go, golang, json, rest, rest-api, swagger
- Language: Go
- Homepage:
- Size: 132 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Simple REST API
[](http://travis-ci.org/mramshaw/Simple-REST-API)
[](http://codecov.io/github/mramshaw/Simple-REST-API?branch=master)
[](http://goreportcard.com/report/github.com/mramshaw/Simple-REST-API)
[](http://godoc.org/github.com/mramshaw/Simple-REST-API)
[](http://github.com/mramshaw/Simple-REST-API/releases)
A proof of concept of a simple REST API in Golang.
All data is held in memory, all transfer is via JSON.
All testing can be with __curl__ or [Swagger](https://swagger.io/) - although Postman should work too.
## Features
- uses the excellent [Gorilla MUX](https://github.com/Gorilla/mux)
- returns appropriate HTTP status codes
- modify Person method implemented
- uses __JSON__
In __Firefox__ at least, specifying "application/json" allows interpretation of the JSON:
## Installation
- __Go__ is required (version 1.7 or later)
Fetch this project as follows:
$ go get -u github.com/mramshaw/Simple-REST-API
This could also be done with __git__ of course:
$ git clone https://github.com/mramshaw/Simple-REST-API.git
Any dependencies will be fetched in the __build__ process.
## Building
- __make__ is required
This will fetch all dependencies, build, and run the executable:
$ make
Local dependencies are stored in a local __api__ directory.
All other dependencies will be stored in a local __go__ directory.
## Unit Tests
- __make__ is required
This will run the unit tests for the DAO (api/people package):
$ make test
The unit tests will be run in __verbose__ mode.
## Usage
Build and run everything:
$ make
Or run the go code (Ctrl-C to terminate):
$ PORT=8100 CORS_HOST=http://localhost:3200 go run RestfulGorillaMux.go
[Specifying `CORS_HOST` allows the swagger-ui to function.]
Or run the executable (Ctrl-C to terminate):
$ PORT=8100 CORS_HOST=http://localhost:3200 ./RestfulGorillaMux
The API will then be accessible at:
http://localhost:8100/v1/people
[Note that the API is __versioned__ (which is probably a best practice).]
## Testing
Use the following __curl__ commands to test (or use the Swagger UI as shown below).
GET (All):
$ curl -v localhost:8100/v1/people
GET (Individual):
$ curl -v localhost:8100/v1/people/5
$ curl -v localhost:8100/v1/people/1
POST (Create):
$ curl -v -X POST -H "Content-Type: application/json" \
-d '{"firstname":"Tommy","lastname":"Smothers"}' \
localhost:8100/v1/people/5
PUT (Update):
$ curl -v -X PUT -H "Content-Type: application/json" \
-d '{"firstname":"Tom","lastname":"Smothers","address":{"city":"Hollywood","state":"CA"}}' \
localhost:8100/v1/people/5
DELETE (Delete):
$ curl -v -X DELETE -H "Content-Type: application/json" \
localhost:8100/v1/people/5
[Specifying __-v__ shows the HTTP status codes; this can be omitted if the status codes are not of interest.]
## Swagger
Although Postman is pretty nice, I've always found Swagger to be a better experience.
The content can be served from [swagger-ui](https://github.com/swagger-api/swagger-ui) (which uses __node__ and __npm__).
On linux, CORS (Cross Origin Resource Sharing) may be temporarily disabled for __chromium__ as follows:
$ chromium-browser --disable-web-security --user-data-dir
[This will only work if chromium is NOT running, as it will otherwise share the browser session.]
## To Do
- [x] Return appropriate HTTP status codes
- [x] Implement code to modify a Person
- [x] Modify to use __JSON__
- [x] Implement API versioning
- [x] Add a SWAGGER definition
- [x] Implement CORS (Cross Origin Resource Sharing) handling
- [x] Refactor data access into a DAO module
- [x] Add tests for the DAO
- [x] Add a health check
- [x] Refactored code
- [ ] Refactor code to NOT use Gorilla/mux
- [x] Move configuration to environment variables (12-Factor everything)
- [x] Make CORS hosts configurable
- [ ] Implement graceful shutdown (available since __Go 1.8__)
- [x] Implement continuous integration (Travis CI)
- [x] Implement code coverage statistics (Codecov.io)
- [x] Implement Go report card (Goreportcard.com)
- [x] Implement [SemVer 2.0.0.](https://semver.org/spec/v2.0.0.html) release tagging
- [x] Add link for Simple-REST-API GoDoc
- [ ] Add Prometheus-style instrumentation
- [ ] Implement method-based Basic AUTH
- [ ] Implement a persistent back-end
- [ ] Investigate upgrading to HTTP2
- [x] Upgrade to latest release of Golang (1.14 as of the time of writing)
- [x] Upgrade `release` badge to conform to new Shields.io standards
## Credits
Inspired by, but since heavily mutated, this great tutorial by Nic Raboy:
https://www.thepolyglotdeveloper.com/2016/07/create-a-simple-restful-api-with-golang/
There is also a YouTube video (which is linked to from the article).