azure-functions-openapi-extension

(โ˜… 388)

This extension provides an Azure Functions app with Open API capability for better discoverability to consuming parties

  • .editorconfig
  • .gitignore
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • es-metadata.yml
  • global.json
  • key.snk
  • LICENSE
  • Microsoft.Azure.WebJobs.Extensions.OpenApi.sln
  • README.md
  • SECURITY.md
  • Settings.StyleCop
  • SUPPORT.md

# Installation Guide

1. Get the code
git clone https://github.com/Azure/azure-functions-openapi-extension

Downloads the entire project code from GitHub to your computer.

cd azure-functions-openapi-extension

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f actions/build-openapi/Dockerfile -t azure-functions-openapi-extension .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 azure-functions-openapi-extension

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. .NET

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • .NET SDK The SDK required for the dotnet command.
dotnet restore

Downloads the packages the project depends on.

dotnet run

Builds the project and runs it immediately.

โœ… After dotnet run, check the message or address shown in the terminal.
// repository documentation