Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Custom type and deserialization into this type

Abierto
#119 5 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
openapi, typescript
Área
api, tooling

Línea de trabajo

Start with the OpenAPI schema snippet and the generated TypeScript output described in the issue, then trace how custom format values are currently represented and how fetched responses are deserialized. Done should define how a custom format maps to an imported TypeScript type and how runtime responses are converted into that type, including the required configuration and tests.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Is there a way to use a custom types in the schema file? And deserialize from string into this type at runtime?

I have the OpenAPI spec like this (just a snippet):

{
  "components": {
    "schemas": {
      "SomeModel": {
        "type": "object",
        "properties": {
          "someProperty": {
            "type": "string",
            "format": "MyCustomType"
          }
        }
      }
    }
  }
}

Which will generate this into the schema file:

export type SomeModel = {
  /**
   * @format MyCustomType
   */
   someProperty: string;
}

But I want to have it like this:

import {MyCustomType} from 'some-library';

export type SomeModel = {
   someProperty: MyCustomType;
}

And deserializing the fetched response during runtime into the MyCustomType

Lenguaje dominante
TypeScript
Estrellas
634
Forks
83
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de fabien0102/openapi-codegen

Todos los issues de fabien0102/openapi-codegen

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.