swagger-api/swagger-codegen

[Rust] Enhancements to Rust generator

Open

#6250 opened on Aug 6, 2017

View on GitHub
 (2 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: RustEnhancement: Generalhelp wanted

Description

Description

Here is a list of enhancements I can think of for the Rust client generator:

  • Add "docstring" to methods in API and model files for documenting the usage
  • Add support for form parameters
  • Add support for file upload (type: file)
  • Add validation for parameters and model properties
  • Make timeout (http) configurable
  • Implement 'object' type conversion (https://github.com/swagger-api/swagger-codegen/pull/6846)

If anyone has any feedback/suggestion, please reply to let us know.

Swagger-codegen version

Latest master

Command line used for generation
mvn clean install
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate  -t modules/swagger-codegen/src/main/resources/rust -i modules/swagger-codegen/src/test/resources/2_0/petstore.yaml -l rust -o samples/client/petstore/rust
Related issues/PRs

https://github.com/swagger-api/swagger-codegen/pull/6105

If anyone wants to work on these enhancements, please reply to let us know and we'll show you some good starting points.

Contributor guide

Tech stack
rust
Domain
tooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
Rust programmingSwagger/OpenAPI specificationCode generation concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Start by examining the existing Rust generator templates in modules/swagger codegen/src/main/resources/rust to understand the current structure. Look at the completed PR #6846 for object type conversion as a reference for implementing similar changes. Then choose one of the unchecked tasks, such as adding docstrings or form parameter support. Review how other Swagger codegen generators handle these features. Post a comment on the issue expressing interest and ask maintainers for specific starting points and files to modify.