swagger-api/swagger-codegen

[FINCH] no enum support

Open

#4.863 geöffnet am 27. Feb. 2017

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)HTML (5.474 Forks)batch import
Enhancement: FeatureFeature: EnumServer: Scalahelp wanted

Repository-Metriken

Stars
 (12.701 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuchen Sie das Finch Codegenerierungsmodul in swagger codegen, um zu verstehen, wie Modelltypen generiert werden. Überprüfen Sie insbesondere, wie Inline Enums derzeit behandelt werden (Erzeugen einer normalen Variablen) und wie referenzierte Enums eine leere Case Klasse erzeugen. Identifizieren Sie die Vorlagendateien und die Logik, die für das Typ Mapping verantwortlich sind. Implementieren Sie eine korrekte Scala Enum Darstellung, z. B. ein sealed trait mit case objects, und stellen Sie sicher, dass die Serialisierung/Deserialisierung mit circe funktioniert.
Tech Stack
scala
Domain
backend
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Scalasbtcode generation
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60