go-problem

KO | EN

gitlite — search

#python #react #typescript #javascript #hacktoberfest #computer-vision #cpp #java #flutter #python3 #html5 #machine-learning

★ 12 Open GitHub ↗

Flexible and customizable Go (golang) implementation of RFC 9457; Problem Details for HTTP APIs

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# go-problem

[![Go Reference](https://img.shields.io/badge/go.dev-reference-007d9c?style=for-the-badge&logo=go&logoColor=white)](https://pkg.go.dev/github.com/airmrcr/go-problem)
[![Build Status](https://img.shields.io/github/actions/workflow/status/airmrcr/go-problem/ci.yml?style=for-the-badge)](https://github.com/airmrcr/go-problem/actions/workflows/ci.yml)
[![Release](https://img.shields.io/github/v/release/airmrcr/go-problem?style=for-the-badge)](https://github.com/airmrcr/go-problem)
[![License](https://img.shields.io/github/license/airmrcr/go-problem?style=for-the-badge)](https://github.com/airmrcr/go-problem/blob/main/LICENSE.md)

Flexible and customizable Go (golang) implementation of [RFC 9457](https://datatracker.ietf.org/doc/html/rfc9457);
Problem Details for HTTP APIs.

## Installation

Install using [go get](https://go.dev/ref/mod#go-get):

``` sh
go get github.com/airmrcr/go-problem
```

Then import the package into your own code:

``` go
import "github.com/airmrcr/go-problem"
```

## Documentation

Documentation is available on [pkg.go.dev](https://pkg.go.dev/github.com/airmrcr/go-problem#section-documentation). It
contains an overview and reference.

### Example

Define reusable problem types and/or definitions:

``` go
var (
	NotFound = problem.Type{
		LogLevel: problem.LogLevelDebug,
		Status:   http.StatusNotFound,
		Title:    http.StatusText(http.StatusNotFound),
	}
	NotFoundDefinition = problem.Definition{
		Type: NotFound,
	    Code: problem.MustBuildCode(404, "ACME"),
	}
)
```

Create a problem using the builder pattern:

``` go
problem.Build().
	Definition(NotFoundDefinition).
	Code(404, "USER").
	Detail("User not found").
	Instance("https://api.example.void/users/123").
	Wrap(err).
	Problem()
// OR:
NotFoundDefinition.Build().
	Code(404, "USER").
	Detail("User not found").
	Instance("https://api.example.void/users/123").
	Wrap(err).
	Problem()
```

Or the option pattern:

``` go
problem.New(
	problem.FromDefinition(NotFoundDefinition),
	problem.WithCode(404, "USER"),
	problem.WithDetail("User not found"),
	problem.WithInstance("https://api.example.void/users/123"),
	problem.Wrap(err),
)
// OR:
NotFoundDefinition.New(
	problem.WithCode(404, "USER"),
	problem.WithDetail("User not found"),
	problem.WithInstance("https://api.example.void/users/123"),
	problem.Wrap(err),
)
```

There's a load of other functions to explore and `problem.Generator` can be used to customize the experience much
further. It even comes with functions for writing problems and errors to an HTTP response and middleware for panic
recovery with problem responses.

## Issues

If you have any problems or would like to see changes currently in development you can do so
[here](https://github.com/airmrcr/go-problem/issues).

## Contributors

If you want to contribute, you're a legend! Information on how you can do so can be found in
[CONTRIBUTING.md](https://github.com/airmrcr/go-problem/blob/main/CONTRIBUTING.md). We want your suggestions and pull
requests!

A list of contributors can be found in [AUTHORS.md](https://github.com/airmrcr/go-problem/blob/main/AUTHORS.md).

## License

See [LICENSE.md](https://github.com/airmrcr/go-problem/raw/main/LICENSE.md) for more information on our MIT license.

go-problem

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README