swagger-api / swagger-api/swagger-codegen
[Jaxrs-cxf] Add support for @ApiParam
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
@ApiParam is currently not implemented in CXF
Swagger-codegen version
2.2.3-SNAPSHOT
Swagger declaration file content or url
see petstore-with-fake-endpoints-models-for-testing.yaml
Command line used for generation
jaxrs-cxf-petstore-server.sh
Steps to reproduce
generate sample
Suggest a Fix
@ApiParam should be included for bodyParams, queryParams, headerParams, pathParams.
Best use one template for all parameters.
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
Run jaxrs-cxf-petstore-server.sh with petstore-with-fake-endpoints-models-for-testing.yaml and inspect the generated JAX-RS CXF server output and existing parameter templates. Trace body, query, header, and path parameters, then verify that each generated parameter includes @ApiParam using one shared template where possible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100