This is a complete example application which uses the majority of the features of the Fintrospect library:
- HTTP request routing with automatic parameter marshalling and unmarshalling (Headers/Query/Path/Body)
- HTTP clients with request creation and route spec reuse for Fake Server implementations
- HTTP response building, including sample JSON library support (Circe) and auto-case class instance marshalling
- Automatic invalid request handling
- Swagger 2.0 documentation and JSON schema generation from example model objects
- Endpoint security
- Templating system (Mustache)
- Serving of static resources
It has been developed in a London-TDD style with outside-in acceptance testing and CDCs for outside dependencies, to give a complete overview of how the app would look when finished. The code itself has been left without optimisation of imports in order to aid comprehension - which is a little frustrating from a maintainer perspective (as you always want your code looking as awesome as possible! :).
- Clone this repo
- Run
sbt test:run, orRunnableEnvironmentfrom an IDE. This will start the application on port 9999 which has been configured to use a fake versions of the remote dependencies (on ports 10000 and 10001) - Just point your browser at http://localhost:9999/
This example models a simple building security system accessible over HTTP. Requirements are:
- Users can ask to be let into and out of the building.
- Usernames are checked for validity against a remote HTTP UserDirectory system.
- Successful entries and exits are logged in a remote HTTP EntryLogger system.
- Ability to check on the current inhabitants of a building.
- Users are tracking in a binary state - inside or not (outside). Only people outside the building can enter, and vice versa.
- All HTTP endpoints are protected with a secret HTTP header to only allow authorised access.
- API documentation should be available.
- Logging of every successful requests should be made.