Using swagger UI with ACA

Arora, Siddhannt 0

I have an ACA which I have deployed and exposing the same via APIM

In azure function you can create an end point for swagger UI and expose it via APIM and with the Azure functions URL you can access the different end point via swagger UI.

How can we expose different end points via swagger UI for an ACA?

MuthuKumaranMurugaachari-MSFT 22,321 Reputation points

2024-02-14T17:03:04.21+00:00

Arora, Siddhannt Thanks for posting your question in Microsoft Q&A. Are you referring to OpenAPI extension for Azure Functions to render Swagger UI (and expose)? If not, please elaborate and this will help in answering it for Container apps.
Arora, Siddhannt 0 Reputation points

2024-02-15T07:44:57.3066667+00:00

@MuthuKumaranMurugaachari-MSFT Thanks for responding.

I was referring to the below way, where in Azure function we can create an handler and have http trigger to expose the swagger UI for all the end points available in the Azure Function.

I am not able to find a similar way or any other way using which I can expose all the end points in Azure Container apps via a swagger UI to the consumers.
MuthuKumaranMurugaachari-MSFT 22,321 Reputation points

2024-02-20T14:30:11.7433333+00:00

Arora, Siddhannt Just a follow up to see if you have any questions on the info shared. Feel free to reach out for any questions.

1 answer

MuthuKumaranMurugaachari-MSFT 22,321 Reputation points

2024-02-15T20:43:26.03+00:00

Arora, Siddhannt Thanks for providing the details and it looks like you are using AzureExtensions.Swashbuckle to generate Swagger UI in Azure Function.

If you are creating ASP.NET Core app for ACA, then you can integrate Swashbuckle as described in doc: Get started with Swashbuckle and ASP.NET Core. You need to add UseSwagger() and UseSwaggerUI() in the middleware so that it generates JSON as well as Swagger UI. More detailed step-by-step guide is available in the doc including custom API info to be displayed in UI. I followed a sample available in https://github.com/Azure-Samples/dotNET-FrontEnd-to-BackEnd-on-Azure-Container-Apps/blob/main/src/Store.ProductApi/Program.cs (also https://azure.github.io/aca-dotnet-workshop/aca/01-deploy-api-to-aca/) and deployed the code (product) in ACA and able to see SwaggerUI like below:

I hope this helps and let me know if any questions.

If you found the answer to your question helpful, please take a moment to mark it as Yes for others to benefit from your experience. Or simply add a comment tagging me and would be happy to answer your questions.
Please sign in to rate this answer.
Arora, Siddhannt 0 Reputation points

2024-02-21T09:00:43.6033333+00:00

Hi @MuthuKumaranMurugaachari-MSFT thanks for the answer, this works if I access the swagger via container app endpoint.
But, If I setup an APIM for the container app and try the swagger url it gives me 404.
For working with APIM in azure function we used to setup SwaggerHandler using AzureExtensions.Swashbuckle
But I am unable to find any alternative to make the swagger work with APIM with container apps.

MuthuKumaranMurugaachari-MSFT 22,321 Reputation points

2024-02-21T15:57:42.33+00:00

Arora, Siddhannt Got it. This makes me wonder whether APIM operation for Swagger UI is added when the container app was imported in APIM. You can check the list of operations for the imported API in APIM and if operation for swagger UI such as swagger/index is missing, then 404 makes sense (resource not found).

You can manually add an operation (steps: https://video2.skills-academy.com/en-us/azure/api-management/add-api-manually#add-and-test-an-operation) in the portal for swagger endpoint and then validate it. If you face any issues, let me know how the operation is configured in APIM, test call etc., we can connect offline to review it further.
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

Using swagger UI with ACA

1 answer

Your answer