swagger-api/swagger-codegen

[Typescript-Fetch] Support for default params

Open

#3,641 建立於 2016年8月25日

在 GitHub 查看
 (6 留言) (0 反應) (0 負責人)HTML (12,701 star) (5,474 fork)batch import
Client: TypeScriptEnhancement: Featurehelp wanted

描述

Description

Typescript-Fetch does not currently generate any code to help with default parameters in methods, but Typescript and ES6 have support for default parameters.

Implementing default parameters can help improve the usability of generated specs.

Swagger-codegen version

2.2.1

Swagger declaration file content or url
Command line used for generation
Steps to reproduce
Related issues
Suggest a Fix

It appears that the defaultValue helper exists to help solve this problem.

{{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}}

貢獻者指南

技術棧
typescriptrest api
領域
apideveloper experience
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
4
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
swagger codegen internalsMustache templatesTypeScriptdefault parameters concept
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
35
研究方向
Examine the defaultValue helper usage in other language generators (e.g., Java, C#) to understand how default values are rendered. Then locate the typescript fetch template files (likely in modules/swagger codegen/src/main/resources/typescript fetch/) and modify the relevant template to include a default value when present. Ensure the generated TypeScript code uses ES6 default parameter syntax. Test with a sample spec containing default parameters.