swagger-api / swagger-api/swagger-codegen
[Java-Playframework] Blocking APIs
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
If the api is making a blocking operation, the controller should return a CompletationStage
Swagger-codegen version
2.3.0
Steps to reproduce
In the newApiController.mustache all ApiActions methods should return CompletationStage
Suggest a fix/enhancement
I would make all methods return CompletationStage. If the operation is synchronous we can just make CompletableFuture.completedFuture
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 with the newApiController.mustache template and inspect how ApiActions methods are generated for Java Play Framework controllers. Check the generated controller behavior for both blocking and synchronous operations. Done means blocking APIs return CompletionStage, while synchronous operations are wrapped with CompletableFuture.completedFuture.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100