OpenSavvy Spine is a library to declare typesafe endpoints in code shared between your multiplatform clients and servers.
Declare your endpoints and DTOs in your common code:
// First, declare your DTOs:
// Here, we use KotlinX.Serialization.
// Any serialization library supported by Ktor is supported by this project.
@Serializable
data class User(
val name: String,
val active: Boolean,
)
// Next, declare your API endpoints:
object Api : RootResource("api") {
object Users : StaticResource("users", parent = Api) {
class ListParameters(data: ParameterStorage) : Parameters(data) {
var includeInactive by parameter(default = true)
}
val list by get()
.parameters(::ListParameters)
.response<User>()
val create by post()
.request<User>()
.response<User>()
}
}Then, implement your routes on the server:
routing {
route(Api.Users.list) {
HttpStatusCode.OK to userRepository.list(includeInactive = parameters.includeInactive)
}
route(Api.Users.create) {
val result = userRepository.create(body)
HttpStatusCode.OK to result
}
}Finally, call the routes from your client:
val user = User("Test", active = true)
client.request(Api.Users.create, user).isSuccessful() shouldBe true
client.request(Api.Users.list).bodyOrNull() shouldContain userLearn more in the documentation.
This project is licensed under the Apache 2.0 license.
See CONTRIBUTING.md.
- To learn more about our coding conventions and workflow, see the OpenSavvy website.
- This project is based on the OpenSavvy Playground, a collection of preconfigured project templates.
If you don't want to clone this project on your machine, it is also available using DevContainer (open in VS Code • IntelliJ & JetBrains IDEs). Don't hesitate to create issues if you have problems getting the project up and running.
