swagger-api/swagger-codegen

[FINCH] no enum support

Open

#4863 aperta il 27 feb 2017

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)HTML (5474 fork)batch import
Enhancement: FeatureFeature: EnumServer: Scalahelp wanted

Metriche repository

Star
 (12.701 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina il modulo di generazione del codice Finch in swagger codegen per capire come vengono generati i tipi modello. Nello specifico, verifica come vengono attualmente gestiti gli enum inline (che producono una variabile normale) e gli enum referenziati (che producono una case class vuota). Identifica i file template e la logica responsabile del mapping dei tipi. Implementa una corretta rappresentazione degli enum Scala, come un sealed trait con case objects, e garantisci che la serializzazione/deserializzazione funzioni con circe.
Tech stack
scala
Dominio
backend
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Scalasbtcode generation
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60