azure-functions-openapi-extension icon indicating copy to clipboard operation
azure-functions-openapi-extension copied to clipboard
verified publisher icon Azure

Modify HeadContent on swagger ui or create new sections

Open haiquangtran opened this issue 3 years ago • 3 comments

I am wanting to display extra information such as build version (not to show in APIM) in Swagger UI. I want to avoid doing it in the description so it does not show in APIM.

I have used the HeadContent attribute in the past on other projects to show this information in the Swagger UI.

Is there any such functionality here? I could not find it.

Cheers

haiquangtran avatar Jul 13 '22 22:07 haiquangtran

@haiquangtran Thanks for the comment! Would you be able to elaborate a bit more?

justinyoo avatar Aug 18 '22 14:08 justinyoo

For instance, I have been using HeadContent in the link below. It provides an ability for me to add text or html at the top of the swagger page (header). This is useful as I'm able to provide text to the UI without it visible in APIM (no external Devs can see it using APIM dev portal) - so only backend will show the text. An ability to provide sections in swagger would also fulfill this. https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/c70947f4ccc80bca528ff1573c0f2462f3e7db8f/src/Swashbuckle.AspNetCore.SwaggerUI/SwaggerUIOptions.cs

haiquangtran avatar Aug 18 '22 20:08 haiquangtran

Still not sure what you're trying to achieve. Would you please be able to provide an example code using Swashbuckle?

justinyoo avatar Aug 22 '22 15:08 justinyoo