Feature Request: Generate swagger file when FunctionApp is compiled

[wsucoug69]

It would be great to have the ability to produce swagger.json or swagger.yaml when the FunctionApp is compiled.

Issue:
When we are running a pipeline (using a bicep template) to create the API operations (in Azure API Management), using the swagger URL for the FunctionApp. The swagger file is not accessible when the FunctionApp is configured with Authentication.

Workaround:
One workaround would be to have an option to output the swagger.json as part of the build where the bicep template cold reference the file locally.

any thoughts??

[justinyoo]

@zapadoody Thanks for the issue. We're working on the CLI feature to sort out your request. However, in the meantime, you can still figure that out by a small trick like:

azure-functions-openapi-extension/.github/workflows/main-build.yaml

Lines 77 to 108 in e432a6b

	- name: Run integration tests (Windows)
	if: matrix.os == 'windows-latest'
	shell: pwsh
	run: |
	dir
	$rootDir = $pwd.Path
	$func = $(Get-Command func).Source.Replace(".ps1", ".cmd")
	cd ./test-integration/Microsoft.Azure.WebJobs.Extensions.OpenApi.TestApp
	Start-Process -NoNewWindow "$func" @("start","--verbose","false")
	Start-Sleep -s 60
	cd $rootDir/test-integration/Microsoft.Azure.WebJobs.Extensions.OpenApi.Document.Tests
	dotnet test . -c Debug
	cd $rootDir
	- name: Run integration tests (Non-Windows)
	if: matrix.os != 'windows-latest'
	shell: pwsh
	run: |
	dir
	$rootDir = $pwd.Path
	cd ./test-integration/Microsoft.Azure.WebJobs.Extensions.OpenApi.TestApp
	Start-Process -NoNewWindow func @("start","--verbose","false")
	Start-Sleep -s 60
	cd $rootDir/test-integration/Microsoft.Azure.WebJobs.Extensions.OpenApi.Document.Tests
	dotnet test . -c Debug
	cd $rootDir

It's our GitHub Actions workflow, which you might be interested in getting the OpenAPI document within your CI/CD pipeline.

And here's the blog post you might want to read.

[wsucoug69]

Perfect thanks for the workaround, I'll keep an eye out for the CLI update.

[NeillCain-zz]

@zapadoody - would you mind sharing detail on how you applied the workaround?

Would be keen to have the swagger file generated in build pipeline myself =)

[justinyoo]

As this PR, #489, has been merged, you can generate the OpenAPI doc within the GitHub Actions workflow on-the-fly.