OpenAPITools / OpenAPITools/openapi-generator
[REQ] Feature Request Change Kotlin Api Calls to return Result type for compile time exception checking
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
My developers regularly forget to handle the exceptions from the Kotlin DefaultApi, the thrown exceptions are annotated above the classes, but these are ignored by Kotlin's ignorance is bliss approach to checked exceptions.
Describe the solution you'd like
As a replacement to the Checked Exceptions of the generated Java code, I propose the Kotlin code results a standard kotlin result type, which catches any underlying exceptions and wraps them in the failure path of the Result type.
Describe alternatives you've considered
I've tried making wrapper calls to all my methods, but this is boilerplate and doesn't solve the problem for other developers
Contributor guide
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 how the Kotlin DefaultApi is generated and how the generated Java code currently exposes checked exceptions. Clarify the Result-based API design and its compatibility implications, then add coverage for generated Kotlin clients showing successful calls and wrapped failures.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, kotlin
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100