swagger-api / swagger-api/swagger-codegen
Feature matrix for client/server configuration properties
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
Currently there are some features which might make sense to document as a feature matrix in the documentation:
- Test-cases
- Logging
- Gzip-support (see https://github.com/swagger-api/swagger-codegen/issues/3279)
- Bean-Validation annotation support (Java) (see #2549 )
- Automatic client-side bean-validation support (Java)
For server stubs we could add
- Logging
- Complete web application support (web.xml + configuration files) to build as webapp
- Jboss support (jboss-web.xml etc.)
- Automatic server-side bean-validation support (@Valid)
- Swagger-support
- WADL-support
I could start with this with the Java (Jersey) client and Jaxrs-CXF server stub (see #2549, #2017).
This could also foster template reuse across projects or at least lookup how features are done in other generators...
What do you think?
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 the existing documentation for the Java (Jersey) client and Jaxrs-CXF server stub. Compare the listed capabilities, including logging, validation, web application support, Swagger and WADL support, with what the generators provide. Done means a documented feature matrix with an agreed scope and complete, accurate entries.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100