softwaremill / softwaremill/tapir
[FEATURE] Generic configuration of Endpoint inputs
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 1.5k
- Forks
- 468
- Avg merge
- 5h 37m
- Merged PRs (30d)
- 34
Description
There's currently no way to default annotations to snake casing without having to manually specify each one. For example, given the following code:
case class Input(
@query
notSnakeCase: Int
)
This will produce an endpoint accepting query parameter of name notSnakeCase. Ideally, I’d like to be able to generically change all such occurrences to not_snake_case instead.
Something similar to the magnolia configuration:
implicit val configuration: AnnotationConfiguration = AnnotationConfiguration.default.withSnakeCaseMemberNames
From thread:
https://softwaremill.community/t/generic-configuration-of-endpointinput-annotations/89/1
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing Tapir's endpoint input annotation handling and the linked community discussion about generic configuration. Define how an implicit configuration should affect annotated member names, including the snake-case example, and confirm the behavior with appropriate endpoint input coverage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100