Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FW: Re: Auto Generated Swagger(OpenAPI) Document for Azure Functions .NET 6 #496

Closed
justinyoo opened this issue Oct 17, 2022 · 0 comments · Fixed by #498
Closed

FW: Re: Auto Generated Swagger(OpenAPI) Document for Azure Functions .NET 6 #496

justinyoo opened this issue Oct 17, 2022 · 0 comments · Fixed by #498
Labels
enhancement New feature or request v1.5.0

Comments

@justinyoo
Copy link
Contributor

*** Email Enquiry ***

Hi, Mohammad.

Thanks for reaching out to us! If you want to add Azure Functions endpoints to
APIM through the OpenAPI document, you can do it through this way:

https://devkimchi.com/2022/03/02/publishing-openapi-doc-from-azfunc-to-apim-within-cicd-pipeline/
[https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdevkimchi.com%2F2022%2F03%2F02%2Fpublishing-openapi-doc-from-azfunc-to-apim-within-cicd-pipeline%2F&data=05%7C01%7CJustin.Yoo%40microsoft.com%7C94d94ba5ca6244f8780c08daaffeddd5%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638015806441236755%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=LEBC1WhOi2CQK1US2bnfVXNejNMbd5gA9rtcF%2FiRu3I%3D&reserved=0]

I'm going to add a PowerShell script and schell script for it soon. In the
meantime, please take a look at the blog post above. For further discussion,
please open a new issue on our repository.

Kind regards,

Justin Yoo
Senior Cloud Advocate | .NET on Azure & Fusion Dev | DevRel Cloud Advocacy
justin.yoo@microsoft.com | aka.ms/meet/justinyoo
[https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Faka.ms%2Fmeet%2Fjustinyoo&data=05%7C01%7CJustin.Yoo%40microsoft.com%7C94d94ba5ca6244f8780c08daaffeddd5%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638015806441236755%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=p%2BioWrPxw%2BJvFeAZtwWHRGpSy0uydtbXKNXbCHxKhl0%3D&reserved=0] | aka.ms/justinyoo
[https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Faka.ms%2Fjustinyoo&data=05%7C01%7CJustin.Yoo%40microsoft.com%7C94d94ba5ca6244f8780c08daaffeddd5%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638015806441236755%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=2rRAwzrXH0ZfQSJQ20Dg8B%2B2BGVbbMG83a55FnvgBb0%3D&reserved=0]
aliencube.org
[https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Faliencube.org%2F&data=05%7C01%7CJustin.Yoo%40microsoft.com%7C94d94ba5ca6244f8780c08daaffeddd5%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638015806441236755%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=R2oXa4jWQsMVh295WNVdUf%2FO8F%2BO8gUfWQvXGw%2F%2BUr4%3D&reserved=0] (KO)
| devkimchi.com
[https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdevkimchi.com%2F&data=05%7C01%7CJustin.Yoo%40microsoft.com%7C94d94ba5ca6244f8780c08daaffeddd5%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638015806441236755%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=BebOfnZfp%2FUXtikdZblDQT585DVQToCFB4fWhkQtIaE%3D&reserved=0] (EN)
| @justinchronicle
[https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Ftwitter.com%2Fjustinchronicle&data=05%7C01%7CJustin.Yoo%40microsoft.com%7C94d94ba5ca6244f8780c08daaffeddd5%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638015806441236755%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=PEI9%2FjGkZqXm0jBfIZo2DB7wjEqjT98mnLggbkhqR4s%3D&reserved=0]


From: Mohammad Imran mohdemraan@gmail.com
Sent: Sunday, 9 October 2022 23:25
To: Azure Functions OpenAPI Extension azfunc-openapi@microsoft.com
Subject: Auto Generated Swagger(OpenAPI) Document for Azure Functions .NET 6
 
You don't often get email from mohdemraan@gmail.com. Learn why this is important
[https://aka.ms/LearnAboutSenderIdentification]

Hi Team,

I'm working on a project based on multiple Azure Functions and using API
Management as a gateway. Now my project has been half done but the team is not
willing to write the attributes for every function, so that those routes get
injected in swagger json. I need to automate the importing of new functions in
Function App into API Management using Azure Pipelines.

I looked at multiple blogs but couldn't find a suitable solution to generate the
swagger document automatically like swashbuckle library could do in dotnet
in-process function. I'm using dotnet-isolated functions.

https://github.com/Azure/azure-functions-openapi-extension
[https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FAzure%2Fazure-functions-openapi-extension&data=05%7C01%7CJustin.Yoo%40microsoft.com%7C94d94ba5ca6244f8780c08daaffeddd5%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638015806441236755%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=zKHqbyfHNqj%2B47NsFGKn%2FUwgFs%2Bwe4tlGpdrSbfqyoc%3D&reserved=0]

Above extension only provides Swagger UI but still needs to add attributes on
every functions.

I'm trying to find something like this provides
https://github.com/vitalybibikov/AzureExtensions.Swashbuckle
[https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fvitalybibikov%2FAzureExtensions.Swashbuckle&data=05%7C01%7CJustin.Yoo%40microsoft.com%7C94d94ba5ca6244f8780c08daaffeddd5%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638015806441236755%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=dfY3WemG0ItKUEQCL7nbI0WKKytPrtBKEO1tBMdQWY0%3D&reserved=0]

Please let me know if there is any workaround for this. If not, any reason you
may know.

Regards,
Mohammad Imran
Cell:- +91 9599661090
Linked In: Mohammad Imran
[https://nam06.safelinks.protection.outlook.com/?url=http%3A%2F%2Fin.linkedin.com%2Fin%2Fmohdimran1&data=05%7C01%7CJustin.Yoo%40microsoft.com%7C94d94ba5ca6244f8780c08daaffeddd5%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638015806441236755%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=fWj%2FGLxZNeSSTOekJ6XPSDyjVm9anEhp4dIWPJ1UIc8%3D&reserved=0]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request v1.5.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant