Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Custom type and deserialization into this type

未关闭
#119 5 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
openapi, typescript
领域
api, tooling

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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

主要语言
TypeScript
星标
634
派生
83
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

fabien0102/openapi-codegen 的其他 Issue

查看 fabien0102/openapi-codegen 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。