Skip to content

Commit

Permalink
added doc.go for better rendering in godoc
Browse files Browse the repository at this point in the history
  • Loading branch information
mschneider82 committed Jan 26, 2024
1 parent 4cf8baf commit 2c1589b
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions doc.go
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

0 comments on commit 2c1589b

Please sign in to comment.