Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/slavikdev/jo
Opinionated Go library to build RESTful JSON APIs.
https://github.com/slavikdev/jo
framework gin go golang golang-library json json-api
Last synced: 6 days ago
JSON representation
Opinionated Go library to build RESTful JSON APIs.
- Host: GitHub
- URL: https://github.com/slavikdev/jo
- Owner: slavikdev
- License: mit
- Created: 2016-12-13T18:50:47.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-12-22T23:11:28.000Z (about 8 years ago)
- Last Synced: 2024-10-31T19:00:40.462Z (about 2 months ago)
- Topics: framework, gin, go, golang, golang-library, json, json-api
- Language: Go
- Size: 68.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JO: Opinionated Go library to build RESTful JSON APIs.
Jo wraps around [gin](https://github.com/gin-gonic/gin) library and implements common patterns
useful in creating JSON APIs, such as strict response structure, authorization, logging, functional testing.
Basically I've extracted all the stuff I usually add building APIs. It wouldn't fit
everyone but that's exactly the point: to agree on common things once and use them as a framework.
If you need more flexibility–go get [gin](https://github.com/gin-gonic/gin).
[](https://travis-ci.org/slavikdev/jo)
[](https://ci.appveyor.com/project/slavikdev/jo)
[](https://codecov.io/gh/slavikdev/jo)
[](https://goreportcard.com/report/github.com/slavikdev/jo)
[](https://godoc.org/github.com/slavikdev/jo)
[](https://github.com/igrigorik/ga-beacon)
```go
import "gopkg.in/slavikdev/jo.v1"
```
## Example
```go
package main
import (
"time"
"gopkg.in/slavikdev/jo.v1"
)
func main() {
// Create api.
api := jo.NewAPI()
// Map routes.
api.Map("get", "/time", getTime)
api.Map("get", "/secret", auth, getSecret)
// Start api on port 9999.
err := api.Run(":9999")
if err != nil {
panic(err)
}
}
// Returns successful response with current time in data field.
func getTime(request *jo.Request) *jo.Response {
currentTime := time.Now()
return jo.Ok(currentTime)
}
// Returns successful response with a word "secret" in data field.
func getSecret(request *jo.Request) *jo.Response {
return jo.Ok("secret")
}
const apiToken string = "0123456789"
// Checks if query string has apiToken argument with specific value.
// If it does--passes request to next handler. Otherwise returns 403 Forbidden error.
func auth(request *jo.Request) *jo.Response {
if request.GetQuery("apiToken") == apiToken {
return jo.Next(nil)
}
return jo.Forbidden()
}
```
The example works as follows:
```
GET localhost:9999/time
```
```
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Sun, 18 Dec 2016 00:51:43 GMT
Content-Length: 64
{
"data": "2016-12-18T02:51:43.07980668+02:00",
"successful": true
}
```
```
GET localhost:9999/secret
```
```
HTTP/1.1 403 Forbidden
Content-Type: application/json; charset=utf-8
Date: Sun, 18 Dec 2016 00:51:10 GMT
Content-Length: 88
{
"data": null,
"error": {
"code": 403,
"message": "Forbidden",
"data": null
},
"successful": false
}
```
```
GET localhost:9999/secret?apiToken=0123456789
```
```
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Sun, 18 Dec 2016 00:40:37 GMT
Content-Length: 36
{
"data": "secret",
"successful": true
}
```