ExtendIt.md

Extend Typedapi to fit your needs

You ended up in this file if:

• the default implements for a HTTP framework doesn't fit your needs
• if the framework you want to use is not supported
• you need more specilized RequestDataBuilder, RouteExtractors, MediaTypes, or the like

General remark

I kept most of the type-classes open. That means you can override them as you like. If a certain class like RequestDataBuilder doesn't fullfil your needs just add another instance. Take a look at available implementations to get an idea how it works or ask a question in Gitter.

Write your own Client backend

To write your own client backend you have to implement the ApiRequest type-classes:

• GetRequest
• PutRequest and PutWithBodyRequest
• PostRequest and PostWithBodyRequest
• DeleteRequest

Take a look into http4s-client to get an idea how to do it.

You can implement all type-classes or just a subset to override implementations provided by TypedApi.

Write your own Server backend

To write your own server backend you have to implement the EndpointExecutor and MountEndpoints type-classes

Take a look into http4s-server to get an idea how to do it.

You can implement all type-classes or just a subset to override implementations provided by TypedApi.