updated docs
parent
c38ee02a49
commit
4bd4e6ca41
32
README.md
32
README.md
|
@ -1,8 +1,38 @@
|
|||
# go-errhttp
|
||||
|
||||
Package **errhttp** provides types errors that make dealing with HTTP response errors easier.
|
||||
Package **errhttp** provides types errors that make dealing with HTTP response errors easier, for the Go programming language.
|
||||
|
||||
|
||||
## Example
|
||||
```go
|
||||
import "github.com/reiver/go-errhttp"
|
||||
|
||||
// ...
|
||||
|
||||
if err := something(); nil != err {
|
||||
return errhttp.BadRequestWrap(err)
|
||||
}
|
||||
|
||||
// ...
|
||||
|
||||
switch err.(type) {
|
||||
case errhttp.BadRequest:
|
||||
//@TODO
|
||||
case errhttp.NotFound:
|
||||
//@TODO
|
||||
case errhtp.InternalServerError:
|
||||
//@TODO
|
||||
|
||||
case errhtp.ClientError:
|
||||
//@TODO
|
||||
case errhtp.ServerError:
|
||||
//@TODO
|
||||
|
||||
default:
|
||||
//@TODO
|
||||
}
|
||||
```
|
||||
|
||||
## Documention
|
||||
|
||||
Online documentation, which includes examples, can be found at: http://godoc.org/github.com/reiver/go-errhttp
|
||||
|
|
|
@ -0,0 +1,33 @@
|
|||
/*
|
||||
Package errhttp provides types errors that make dealing with HTTP response errors easier.
|
||||
|
||||
Example
|
||||
|
||||
import "github.com/reiver/go-errhttp"
|
||||
|
||||
// ...
|
||||
|
||||
if err := something(); nil != err {
|
||||
return errhttp.BadRequestWrap(err)
|
||||
}
|
||||
|
||||
// ...
|
||||
|
||||
switch err.(type) {
|
||||
case errhttp.BadRequest:
|
||||
//@TODO
|
||||
case errhttp.NotFound:
|
||||
//@TODO
|
||||
case errhtp.InternalServerError:
|
||||
//@TODO
|
||||
|
||||
case errhtp.ClientError:
|
||||
//@TODO
|
||||
case errhtp.ServerError:
|
||||
//@TODO
|
||||
|
||||
default:
|
||||
//@TODO
|
||||
}
|
||||
*/
|
||||
package errhttp
|
Loading…
Reference in New Issue