microsoft / microsoft/OpenAPI.NET.OData
Expose a middleware to output Open API description for a certain OData service
Đang mở
Chưa có ai nhận issue này.
status:needs-discussion
type:enhancement
- Ngôn ngữ chính
- C#
- Star
- 240
- Fork
- 70
- Merge trung bình
- 7 giờ 59 phút
- Pull request đã merge (30 ngày)
- 13
Mô tả
Maybe we can have an extension middleware to expose the OpenAPI description for a certain OData service.
For example:
public class ODataOpenApiMiddleware
{
private readonly RequestDelegate next;
public ODataOpenApiMiddleware(RequestDelegate next)
{
this.next = next;
}
public async Task Invoke(HttpContext context)
{
// implementation here
}
}
Extension method:
public static IApplicationBuilder UseODataOpenApi(this IApplicationBuilder app)
{
return app.UseMiddleware<ODataOpenApiMiddleware>();
}
Configure the Middleware:
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
app.UseODataOpenApi();
app.UseRouting();
app.UseEndpoints(...);
}
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
Bắt đầu với ODataOpenApiMiddleware được đề xuất, phương thức Invoke của nó, phần mở rộng UseODataOpenApi và ví dụ Configure trong issue này. Làm rõ cách middleware phải chọn một dịch vụ OData cụ thể và hành vi phản hồi cũng như định tuyến nào xác định việc hoàn tất; không có tệp triển khai hoặc bài kiểm thử nào được xác định.
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
- 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