swagger-api/swagger-codegen

Client-generation: Allow data validation on the client side (using minLength/maxLength)

Open

#2,549 opened on Apr 11, 2016

View on GitHub
 (36 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: JavaEnhancement: Featurehelp wanted

Description

Currently the generated Java-clients perform required-validation automatically. Do you think this makes sense for minLength/maxLength as well, to reject the request on the client side before sending to the server?

For Java the JSR-303 Bean Validation API could be used for this automatically. For other languages maybe a JSON-schema validation could be used.

Contributor guide

Tech stack
java
Domain
apideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
OpenAPI specSwagger Codegen templatesJSR 303 Bean Validation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Investigate existing validation mechanisms in generated clients (e.g., required validation). Look at template files for Java (e.g., `modules/swagger codegen/src/main/resources/Java/libraries/okhttp gson/`) and other languages to understand how annotations are added. Explore using JSR 303 annotations for Java clients and JSON schema validation for others. Check the 36 comments for prior discussion or attempts.
Client-generation: Allow data validation on the client side (using minLength/maxLength) · swagger-api/swagger-codegen#2549 | Good First Issue