swagger-api/swagger-codegen

Dynamic html doesn't show parameter's "optional or required" info

开放

#3,240 创建于 2016年6月29日

在 GitHub 查看贡献者指南
 (2 条评论) (0 个反应) (0 位负责人)HTML (5,474 个派生)batch import
Client: HTMLFeature: DocumentationIssue: Bughelp wanted

仓库指标

星标
 (12,701 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

Description

Dynamic HTML generated from swagger doesn't contain parameter's 'optional or required' information. This is present in static html.

Swagger-codegen version

Swagger 2.0

Swagger declaration file content or url
Command line used for generation
Steps to reproduce

Generate dynamic html from any template. required flag for parameters not coming.

Related issues

Static html file doesn't have tags information in it.

Suggest a Fix

贡献者指南

研究方向
首先，在 swagger codegen 仓库中找到动态 HTML 模板文件，很可能位于 modules/swagger codegen/src/main/resources/htmlDocs/ 目录下。将其与静态 HTML 模板进行比较，以确定显示“必填”或“可选”信息的位置。然后，检查数据模型，确保传递给模板的上下文（可能在参数对象中）包含 'required' 字段。最后，修改动态模板，添加一个条件块，根据参数的 'required' 属性显示“必填”或“可选”。参考现有的静态 HTML 模板以获取确切的语法。
技术栈
html
领域
apidocumentation
议题类型
缺陷
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
GitOpenAPI/Swagger basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70