-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added doc.go for better rendering in godoc
- Loading branch information
1 parent
4cf8baf
commit 2c1589b
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
/* | ||
Package problem implements RFC7807 `application/problem+json` and | ||
`application/problem+xml` using the functional options paradigm. | ||
# Features | ||
- Compatible with `application/problem+json`. | ||
- Inspired by https://github.com/zalando/problem. | ||
- RFC link https://tools.ietf.org/html/rfc7807. | ||
- A Problem implements the Error interface and can be compared with errors.Is(). | ||
- Wrap an error to a Problem. | ||
- `application/problem+xml` is also supported using `xml.Unmarshal` and `xml.Marshal`. | ||
- Auto-Title based on StatusCode with `problem.Of(statusCode)`. | ||
# Installation | ||
To install the package, run: | ||
go get -u schneider.vip/problem | ||
*/ | ||
package problem |