swagger-api/swagger-codegen

[FINCH] no enum support

Open

#4 863 ouverte le 27 févr. 2017

Voir sur GitHub
 (4 commentaires) (0 réactions) (0 assignés)HTML (5 474 forks)batch import
Enhancement: FeatureFeature: EnumServer: Scalahelp wanted

Métriques du dépôt

Stars
 (12 701 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Description

The Finch code generator does not support enums. An inline enum generates a normal variable of the desired type; a referenced enum generates an empty case class.

Swagger-codegen version

2.2.2-SNAPSHOT

Swagger declaration file content or url
      resultCode:
        type: string
        enum: [
          "OK",
          "EXCEPTION",
          "BAD_REQUEST"
        ]
Suggest a Fix

As far as I know there is no single best implementation choice for enumerations in scala. Possible choices are:

  • scala enumeration class (no warning for non-exhaustive match, type erasure issues)
  • sealed case objects (no easy way of iterating through values, no default serialization / deserialization) The serialization issue might not be a problem if circe supports it; still, scala enumerations might be easier to implement.

Guide contributeur

Direction de recherche
Examinez le module de generation de code Finch dans swagger codegen pour comprendre comment les types de modele sont generes. Plus precisement, examinez comment les enums en ligne sont actuellement traitees (production d'une variable normale) et comment les enums referencees produisent une classe de cas vide. Identifiez les fichiers de template et la logique responsable du mappage des types. Implementez une representation correcte des enums Scala, comme un sealed trait avec des case objects, et assurez vous que la serialisation/deserialisation fonctionne avec circe.
Stack technique
scala
Domaine
backend
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Scalasbtcode generation
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60