No description
e4865644c1
I spend some considerable time reverse engineering the module, so I thought I’d write the documentation I would have liked to see. The strategy here is that a user not necessarily has insight into how servant works internally, or even how to write complex servant routes, they just want to generate a list of endpoints and convert the `Req` type into e.g. generated code in $language. Thus, they need to know the semantics of all fields of Req, how they interact and how they relate to a plain http route. I made sure every `f` is replaced with `ftype`, so we have one conventional way of referring to the foreign type argument everywhere. Some enums are not set at all, they are marked as such. `_reqBodyContentType` introduces a major restriction of the module, so that is mentioned in the documentation for now, until the time it will be fixed. A few TODO’s describe places where types don’t make sense but would introduce API-breaking changes, so these should probably be simplified, but bundled in one go. |
||
|---|---|---|
| .github | ||
| changelog.d | ||
| doc | ||
| nix | ||
| servant | ||
| servant-client | ||
| servant-client-core | ||
| servant-client-ghcjs | ||
| servant-conduit | ||
| servant-docs | ||
| servant-foreign | ||
| servant-http-streams | ||
| servant-machines | ||
| servant-pipes | ||
| servant-server | ||
| .gitignore | ||
| .stylish-haskell.yaml | ||
| cabal.ghcjs.project | ||
| cabal.project | ||
| CONTRIBUTING.md | ||
| default.nix | ||
| hlint.yaml | ||
| Makefile | ||
| README.md | ||
| servant.png | ||
| setup.py | ||
| sources.txt | ||
| stack-ghcjs.yaml | ||
| stack.yaml | ||
| streaming-benchmark.sh | ||
servant - A Type-Level Web DSL
Getting Started
We have a tutorial that introduces the core features of servant. After this article, you should be able to write your first servant webservices, learning the rest from the haddocks' examples.
The core documentation can be found here. Other blog posts, videos and slides can be found on the website.
If you need help, drop by the IRC channel (#servant on freenode) or mailing list.
Contributing
See CONTRIBUTING.md
Release process outline (by phadej)
- Update changelog and bump versions in
mastergit log --oneline v0.12.. | grep 'Merge pull request'is a good starting point (use correct previous release tag)
- Create a release branch, e.g.
release-0.13- Release branch is useful for backporting fixes from
master
- Release branch is useful for backporting fixes from
- Smoke test in
servant-universegit submodule foreach git checkout masterandgit submodule foreach git pullto get newest of everything.cabal new-build --enable-tests allto verify that everything builds, andcabal new-test allto run tests- It's a good idea to separate these steps, as tests often pass, if they compile :)
- See
cabal.projectto selectivelyallow-newer - If some packages are broken, on your discretisation there are two options:
- Fix them and make PRs: it's a good idea to test against older
servantversion too. - Temporarily comment out broken package
- Fix them and make PRs: it's a good idea to test against older
- If you make a commit for
servant-universe, you can use it as submodule in private projects to test even more
- When ripples are cleared out:
git tag -sthe releasegit push --tagscabal sdistandcabal upload
TechEmpower framework benchmarks
We develop and maintain the servant TFB entry in https://github.com/haskell-servant/FrameworkBenchmarks/
To verify (i.e. compile and test that it works)
./tfb --mode verify --test servant servant-beam servant-psql-simple --type json plaintext db fortune
To compare with warp
./tfb --mode benchmark --test warp servant servant-beam servant-psql-simple --type json plaintext db fortune
To compare with reitit (Clojure framework)
./tfb --mode benchmark --test reitit reitit-async reitit-jdbc servant servant-beam servant-psql-simple --type json plaintext db fortune
You can see the visualised results at https://www.techempower.com/benchmarks/#section=test