Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Custom type and deserialization into this type

Aperta
  • Qualcosa non va?
#119 5 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
openapi, typescript
Ambito
api, tooling

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
TypeScript
Stelle
634
Fork
83
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di fabien0102/openapi-codegen

Tutte le issue di fabien0102/openapi-codegen

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.