Azure / Azure/azure-functions-openapi-extension

Support for ASP.NET Core integration request/response model

Open
#614 0 comments 3 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
388
Forks
202
PR merge metrics
No merged PRs in 30d

Description

**Describe the issue**
`OpenApiTriggerFunction` endpoints such as `RenderSwaggerDocument`, `RenderOpenApiDocument`, etc. do not currently work with isolated model and [ASP.NET Core integration](https://learn.microsoft.com/en-us/azure/azure-functions/dotnet-isolated-process-guide#aspnet-core-integration).

I think that the library should include another set of endpoints which use `HttpRequest` and `HttpResponse`/`IActionResult`.

**To Reproduce**
Steps to reproduce the behavior:
1. Start application with [Core Tools version 4.0.5240 or later](https://learn.microsoft.com/en-us/azure/azure-functions/functions-run-local)
2. Navigate to api/swagger.json
3. Blank page is displayed

**Expected behavior**
OpenAPI json document is displayed

**Screenshots**
![image](https://github.com/Azure/azure-functions-openapi-extension/assets/139770120/2634f9cc-05c6-4c99-a4d2-1ef96785fa6e)

**Environment (please complete the following information, if applicable):**
- OS: Windows
- Browser: edge
- Version [e.g. 22]: Tried both 1.5.1 and 2.0.0-preview2

**Additional context**
-

Contributor guide

Open the contributing guide

Research direction

Start with the OpenApiTriggerFunction endpoints named in the issue, especially RenderSwaggerDocument and RenderOpenApiDocument, and reproduce the blank api/swagger.json response using Core Tools 4.0.5240 or later. Compare the isolated ASP.NET Core integration request/response model with the existing endpoint approach. Done means the OpenAPI JSON renders correctly through the requested HttpRequest and HttpResponse/IActionResult endpoints.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, csharp, openapi
Domain
api, backend, cloud
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.