swagger-api/swagger-codegen

[Eiffel] Enhancements to the Eiffel generator

Open

#6057 opened on Jul 14, 2017

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

Description

Description

Here is a list of enhancements I can think of.

  • Create shell scripts, batch files to generate Eiffel Petstore samples
  • Setup CI (travis, shippable, etc) to cover the Eiffel Petstore samples.
  • Refactor part of the code into an Abstract Eiffel base class, which can be later used in Eiffel server stub generators
  • Add Eiffel Style guide to the contribution guidelines so that Eiffel contributors know what to follow in terms of code style
  • Add {{#required}} .. {{/required}} to make sure the parameters (query, form, header, body) is non-null (exmaple)
  • Add support for validation rules defined in the spec (e.g. validation for parameters in Ruby API layer)

Please feel free to reply with other suggestions.

Swagger-codegen version

Latest master

Related issues/PRs

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

Suggest a Fix/Enhancement

If anyone wants to work on the enhancement, please reply to let us know.

cc @jvelilla

Contributor guide

Tech stack
javarubyhtmlrest api
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.
mostly clear
Prerequisites
Knowledge of Eiffel languageFamiliarity with swagger codegenMustache templatingCI setup concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
The issue consolidates several enhancements for the Eiffel generator. Review PR #6036 for context. Examine the Ruby generator's validation implementation in modules/swagger codegen/src/main/resources/ruby/api.mustache (lines 67-110) as a pattern. Investigate the Eiffel generator source in modules/swagger codegen/src/main/java/io/swagger/codegen/languages/ and templates in modules/swagger codegen/src/main/resources/Eiffel/. Focus on adding required parameter handling and validation rules.