swagger-api/swagger-codegen

[Rust] Enhancements to Rust server generator

Open

#6756 opened on Oct 19, 2017

View on GitHub
 (15 comments) (4 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: RustEnhancement: GeneralServer: Rusthelp wanted

Description

Description
  • rust2 is not a very informative name (renamed to rust-server via https://github.com/swagger-api/swagger-codegen/pull/6747)
  • Currently uses hyper 0.10 - work underway to upgrade to hyper 0.11 (which adds full async support)
  • Documentation on how to use the generated code in a Rust project is lacking
  • Consolidate the client generator with rust generator (rust-server generates both server and client code)
  • Add a means of testing rust-server's XML support back in (in a way that doesn't break everything else!). I believe other generators already do this, so it should not be over-hard.
  • The rust-server sample was generated from the pre-reversion petstore yaml. It should be re-generated from the current petstore yaml.
Swagger-codegen version

Latest master

Related issues/PRs

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

Suggest a fix/enhancement

If anyone wants to work on these tasks, please reply to let us know.

Contributor guide

Tech stack
rust
Domain
backendapitooling
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.
clear
Prerequisites
Rust programmingHyper HTTP librarySwagger/OpenAPICode generation concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Start by reading the linked PR #6747 to understand the renaming changes. Then examine the current Rust server generator code in the 'modules/swagger codegen/src/main/java/io/swagger/codegen/languages/RustServerCodegen.java' file. Consider upgrading hyper from 0.10 to 0.11 by reviewing the existing hyper dependencies. For documentation, look at the generated README and add usage instructions. Check the petstore sample generation script in the project root.