swagger-api/swagger-codegen

[FINCH] no enum support

Open

#4.863 aberto em 27 de fev. de 2017

Ver no GitHub
 (4 comments) (0 reactions) (0 assignees)HTML (5.474 forks)batch import
Enhancement: FeatureFeature: EnumServer: Scalahelp wanted

Métricas do repositório

Stars
 (12.701 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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.

Guia do colaborador

Direção de pesquisa
Investigue o módulo de geração de código Finch no swagger codegen para entender como os tipos de modelo são gerados. Especificamente, veja como os enums inline são atualmente tratados (produzindo uma variável normal) e como os enums referenciados produzem uma case class vazia. Identifique os arquivos de template e a lógica responsável pelo mapeamento de tipos. Implemente uma representação adequada de enum em Scala, como um sealed trait com case objects, e garanta que a serialização/desserialização funcione com circe.
Pilha de tecnologia
scala
Domain
backend
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Scalasbtcode generation
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60