Expose a middleware to output Open API description for a certain OData service
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
Start with the proposed ODataOpenApiMiddleware, its Invoke method, the UseODataOpenApi extension, and the Configure example in this issue. Clarify how the middleware should select a certain OData service and what response and routing behavior define completion; no implementation files or tests are identified.
Written by the indexing model from the issue text.
Description
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(...);
}
- Dominant language
- C#
- Stars
- 240
- Forks
- 70
- Avg merge
- 7h 59m
- Merged PRs (30d)
- 13
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/OpenAPI.NET.OData
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
microsoft/OpenAPI.NET.OData#661 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 58/100
microsoft/OpenAPI.NET.OData#852 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
microsoft/OpenAPI.NET.OData#833 ·
-
status:needs-more-information
Difficulty 4/5 3-5 days Newbie friendliness 42/100
microsoft/OpenAPI.NET.OData#723 · 1 comment · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
microsoft/OpenAPI.NET.OData#720 ·
All issues in microsoft/OpenAPI.NET.OData
Similar issues
-
type/automation type/tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
t/bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
ci-failure-cause test-failure
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area:auth FE mvp P3
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
klasolsson81/jobbliggaren#1788 ·