microsoft / microsoft/OpenAPI.NET
Add Builder to simplify openapi document object construction
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- C#
- Star
- 1.6k
- Fork
- 286
- Merge trung bình
- 6 giờ 38 phút
- Pull request đã merge (30 ngày)
- 35
Mô tả
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();
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Issue không nêu tên tệp, bài kiểm thử hoặc điểm vào nào. Hãy bắt đầu bằng việc xem xét mô hình đối tượng tài liệu OpenAPI hiện có và các mẫu xây dựng hiện tại, sau đó làm rõ các operation, schema và server được builder hỗ trợ trước khi triển khai. Công việc được xem là hoàn tất khi một builder API đã được thống nhất có thể tạo một tài liệu OpenAPI tương đương thông qua Build().
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- csharp, openapi
- Lĩnh vực
- api, backend-api-design
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 25/100