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

Correct handling of `style` and `explode`.

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

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
技术栈
typescript
领域
tooling

调研方向

Start by locating the query-parameter generation entry point and its handling of OpenAPI parameter style and explode defaults. Compare the generated TypeScript with the OpenAPI 3.0 Parameter Object rules, then add or update tests so the intended output for form-style query parameters is explicit and covered.

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

描述

OpenAPI spec:

targets:

  get:
    tags:
      - targets
    operationId: getProductTargets
    parameters:
      - name: searchParameters
        description: "Some description"
        in: query
        required: true
        schema:
          $ref: "..ProductTargetsSearch"
    responses:
      200:
        description: "Some description"
        content:
          application/json:
            schema:
              $ref: "..GetProductTargetsResponse"
      400:
        description: "Some description"
        content:
          application/json:
            schema:
              $ref: "..ErrorDto"
      500:
        description: "Ошибка на сервере"
        content:
          application/json:
            schema:
              $ref: "..ErrorDto"

Generator emits type for queryParams:

export type GetProductTargetsQueryParams = {
    /**
     * Some description
     */
    searchParameters: Schemas.ProductTargetsSearch;
};

But by spec https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#parameter-object
parameter in: query has default value of style - form. So explode default value is true for form style. Spec says:

When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map

Should generator emit queryParam type with spreaded params? if no, why?

主要语言
TypeScript
星标
635
派生
82
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 摘要。