Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cdepillabout/servant-checked-exceptions
type-level errors for Servant APIs.
https://github.com/cdepillabout/servant-checked-exceptions
client docs errors exceptions hacktoberfest haskell json servant server
Last synced: about 15 hours ago
JSON representation
type-level errors for Servant APIs.
- Host: GitHub
- URL: https://github.com/cdepillabout/servant-checked-exceptions
- Owner: cdepillabout
- License: bsd-3-clause
- Created: 2017-04-21T04:05:56.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-27T03:55:57.000Z (over 1 year ago)
- Last Synced: 2024-04-26T02:21:26.445Z (7 months ago)
- Topics: client, docs, errors, exceptions, hacktoberfest, haskell, json, servant, server
- Language: Haskell
- Homepage: https://hackage.haskell.org/package/servant-checked-exceptions
- Size: 243 KB
- Stars: 71
- Watchers: 7
- Forks: 14
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Servant.Checked.Exceptions
==========================
[](https://github.com/cdepillabout/servant-checked-exceptions)
[](https://hackage.haskell.org/package/servant-checked-exceptions)
[](http://stackage.org/lts/package/servant-checked-exceptions)
[](http://stackage.org/nightly/package/servant-checked-exceptions)
`servant-checked-exceptions` provides a way to specify errors thrown by a
Servant api on the type level. It allows easy composition between different
error types.
`servant-checked-exceptions` provides the
[`Throws`](https://hackage.haskell.org/package/servant-checked-exceptions/docs/Servant-Checked-Exceptions.html#t:Throws)
data type to signify which errors can be thrown by an api. For instance,
imagine a `getAuthor` api that returns an `Author` based on an `AuthorId`:
```haskell
-- This is a servant-compatible type describing our api.
type Api =
"author" :>
Capture "author-id" AuthorId :>
Throws DatabaseError :>
Throws AuthorNotFoundError :>
Get '[JSON] Author
-- These are the two errors that can be thrown:
data DatabaseError = DatabaseError
data AuthorNotFoundError = AuthorNotFoundError
```
The corresponding handler function uses the
[`Envelope`](https://hackage.haskell.org/package/servant-checked-exceptions/docs/Servant-Checked-Exceptions.html#t:Envelope)
data type to model the possibility of returning an `Author` successfully, or
either `DatabaseError` or `AuthorNotFoundError` unsuccessfully.
Internally, `Envelope` is using an open sum-type to easily represent multiple
different errors:
```haskell
getAuthorHandler
:: AuthorId
-> Handler (Envelope '[DatabaseError, AuthorNotFoundError] Author)
getAuthorHandler authorId = ...
```
For more documentation and usage examples, see the
[documentation](https://hackage.haskell.org/package/servant-checked-exceptions) on Hackage.
## Why would I want to use this?
Using `Envelope` with its open sum-type to represent errors gives us an easy
way to reuse errors on multiple routes.
For instance, imagine that we had another api for updating an author's name,
given the author's ID. Using `Throws` and `Envelope`, it might look like this:
```haskell
type Api =
"update-author-name" :>
Capture "author-id" AuthorId :>
Capture "author-name" AuthorName :>
Throws DatabaseError :>
Throws AuthorNotFoundError :>
Throws AuthorNameTooShort :>
Post '[JSON] Author
data AuthorNameTooShort = AuthorNameTooShort
postChangeAuthorName
:: AuthorId
-> AuthorName
-> Handler (Envelope '[DatabaseError, AuthorNotFoundError, AuthorNameTooShort] Author)
postChangeAuthorName authorId newAuthorName = ...
```
We are able to reuse the `DatabaseError` and `AuthorNotFoundError`. If we try
to return an error that is not declared using `Throws`, GHC will give us an
error. We get flexiblity and type-safety.
When using [servant-docs](https://hackage.haskell.org/package/servant-docs) to
create documentation, only one instance of `ToSample` needs to be created for
each error (`DatabaseError`, `AuthorNotFoundError`, and `AuthorNameTooShort`).
Multiple instances of `ToSample` do not need to be created for _every_
different `Envelope` used in a handler.
## Example
This repository contains an [example](servant-checked-exceptions/example/) of using
`servant-checked-exceptions`. This includes an [api](servant-checked-exceptions/example/Api.hs),
[server](servant-checked-exceptions/example/Server.hs), [client](servant-checked-exceptions/example/Client.hs), and
[documentation](servant-checked-exceptions-core/example/Docs.hs).
Below I show how to compile and run these examples.
### Compile
The examples can be compiled by using the `buildexample` flag:
```sh
$ stack build --flag servant-checked-exceptions-core:buildexample --flag servant-checked-exceptions:buildexample
```
This creates three executables. A server, a client, and a documentaiton
generator.
### Run the server
The server is a small example that will take search queries and return results.
The server can be run with the following command:
```sh
$ stack exec -- servant-checked-exceptions-example-server
```
This runs the server on port 8201. Here is an example of using `curl` to
access the server. This will send the query `hello`:
```sh
$ curl \
--request POST \
--header 'Accept: application/json' \
'http://localhost:8201/lax-search/hello'
{"data":"good"}
```
If you try to send a query that is not `hello`, the server will return an error:
```sh
$ curl \
--request POST \
--header 'Accept: application/json' \
'http://localhost:8201/lax-search/goodbye'
{"err":"BadSearchTermErr"}
```
There is also a strict api, that requires `hello` to be capitalized like `Hello`:
```sh
$ curl \
--request POST \
--header 'Accept: application/json' \
'http://localhost:8201/strict-search/hello'
{"err":"IncorrectCapitalization"}
$ curl \
--request POST \
--header 'Accept: application/json' \
'http://localhost:8201/strict-search/Hello'
{"data":"good"}
```
### Run the client
The client provides a small command line application to query the server. In
order to use the client, the server must be running.
Use the client to access the lax search api:
```sh
$ stack exec -- servant-checked-exceptions-example-client foobar
the search term was not "Hello"
$ stack exec -- servant-checked-exceptions-example-client hello
Success: good
```
Use the client to access the strict search api:
```sh
$ stack exec -- servant-checked-exceptions-example-client --strict hello
the search term was not capitalized correctly
$ stack exec -- servant-checked-exceptions-example-client --strict Hello
Success: good
```
### Run the documentation generator
The documentation generator will generate documentation for the api in Markdown:
```sh
$ stack exec -- servant-checked-exceptions-core-example-docs
```
Here is a small example of the documentation that will be generated for the lax
search api:
```markdown
## POST /lax-search/:query
#### Captures:
- *query*: a search string like "hello" or "bye"
#### Response:
- Status code 200
- Headers: []
- Supported content types are:
- `application/json`
- This is a successful response.
{"data":"good"}
- a completely incorrect search term was used
{"err":"BadSearchTermErr"}
```
You can see that both the success and error responses are documented.
## Packaging the core types
[`servant-checked-exceptions-core`](https://hackage.haskell.org/package/servant-checked-exceptions-core)
exports the core types need for building an API with checked exceptions,
allowing you to avoid depending on server-side libraries like `warp`, `Glob`
and `servant-server`. This can be useful if you are writing an API meant to be
shared with ghcjs and run in a browser, where these dependencies aren't
available.
## Limitations
Currently, `servant-client` only treats HTTP responses as successful if they
have a status code of 2XX. This means that any non-2XX errors thrown by
`servant-checked-exceptions` don't get parsed into a typed `Envelope` as
expected, but raised as a Servant `ClientError`. For more information, see
[issue #27](https://github.com/cdepillabout/servant-checked-exceptions/issues/27).
## Maintainers
- [](http://github.com/cdepillabout)
- [](http://github.com/imalsogreg)