Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ddymko/go-jsonerror

Small package which wraps error responses to follow jsonapi.org
https://github.com/ddymko/go-jsonerror

go golang-json json-api json-error jsonapi-spec

Last synced: about 1 month ago
JSON representation

Small package which wraps error responses to follow jsonapi.org

Lists

README 

        
# Go-JsonError

[![Go Report Card](https://goreportcard.com/badge/github.com/ddymko/go-jsonerror)](https://goreportcard.com/report/github.com/ddymko/go-jsonerror) [![Build Status](https://travis-ci.org/ddymko/go-jsonerror.svg?branch=master)](https://travis-ci.org/ddymko/go-jsonerror) [![Coveragestatus](https://codecov.io/gh/ddymko/go-jsonerror/branch/master/graph/badge.svg)](https://codecov.io/github/ddymko/go-jsonerror?branch=master)

[![GoDoc](https://godoc.org/github.com/ddymko/go-jsonerror?status.svg)](https://godoc.org/github.com/ddymko/go-jsonerror)

[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)  



Go-JsonError is meant to allow us to easily create json response errors that follow the JsonApi spec.



[Json API Spec](https://jsonapi.org/format/#errors)



## Usuage



In order to use jsonError you will need to initliaze the ErrorJson struct. Then when you would like to add an error you must pass in a ErrorComp struct to the AddError().



This follows the jsonapi spec where the error response must return an array.



Here is a basic example



``` go

	var err ErrorJSON



	errorComposition := ErrorComp{

		Detail: "this is a error message",

		Code:   "This is the code",

		Source: Source{

			Pointer: "/unit/tests",

		},

		Title:  "Title Test",

		Status: 200,

	}



	err.AddError(errorComposition)



	err.Error()

	err.ErrorByte()

```



## Running the tests



This package is just using the standard test packge included with go. You can run the test cases with



``` sh

go test ./...

```



## Contributing



Please feel free to submit any pull requests.



## Versioning



We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/ddymko/go-jsonerror/tags).



## Authors



* **David Dymko**



## License



This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details