microsoft / microsoft/OpenAPI.NET
Add Builder to simplify openapi document object construction
未关闭
还没有人认领这个 Issue。
help wanted
type:enhancement
- 主要语言
- C#
- 星标
- 1.6k
- 派生
- 286
- 平均合并
- 6 小时 38 分钟
- 30 天内合并 PR
- 35
描述
A regular C# builder pattern would help a lot in many scenarios.
Building an object now is very complex...
Builder pattern is also the "de facto" in Aspnetcore.. so would make sense to expose a similar api
var openApiDocumentBuilder = new OpenApiDocumentBuilder()
.WithServers(...)
.WithOperation(...)
.WithOperation(...)
.WithSchema(...);
//... etc
var openApiDocument = openApiDocumentBuilder.Build();
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
该 issue 没有指定文件、测试或入口点。首先检查现有的 OpenAPI 文档对象模型和当前的构造模式,然后在实现之前明确 builder 支持的操作、schemas 和 servers。完成的标准是:达成一致的 builder API 可以通过 Build() 构造出等价的 OpenAPI 文档。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- csharp, openapi
- 领域
- api, backend-api-design
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 25/100