ktorio/ktor

ktor-locations for (multiplatform) clients.

Open

#1304 opened on Aug 28, 2019

View on GitHub
 (4 comments) (7 reactions) (1 assignee)Kotlin (14,408 stars) (1,254 forks)batch import
featurehelp wanted

Description

Subsystem Locations

Is your feature request related to a problem? Please describe. When writing a multiplatform frontend (i.e. Android, iOS) using ktor-client, one has to use strings for get() / update() / delete() calls to a (Ktor-based) backend. This is tedious and error-prone and replicates what had to tbe done for the backend.

Describe the solution you'd like ktor-locations is available for clients as well and can be used in multiplatform projects.

Motivation to include to ktor Clients using ktor-client would benefit from using the same type-safe API path types that can be used for backends. This would increase code re-use and allows for easier refactoring.

Contributor guide

Tech stack
kotlin
Domain
apimobile
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
KotlinKtorMultiplatform development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
15
Research direction
Investigate the existing ktor locations module for server side implementation to understand its structure and how it generates path templates. Look into ktor client's request API to plan how to reuse the same types for client URLs. Review the issue comments for any design discussions or proposed approaches. The main challenge is adapting the type safe path generation to Kotlin Multiplatform without platform specific reflection.