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

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/Azure/azure-functions-openapi-extension

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd azure-functions-openapi-extension

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
⚠️ 이 프로젝트는 규모가 큰 저장소라, 이 방법이 실제 핵심 제품이 아니라 내부 하위 패키지를 가리키는 것일 수 있습니다. README 전체를 함께 확인해보세요.
docker build -f actions/build-openapi/Dockerfile -t azure-functions-openapi-extension .

Dockerfile을 기반으로 실행 가능한 이미지를 빌드합니다.

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

빌드된 이미지를 실제 컨테이너로 실행합니다.

터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

3. .NET

보통
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • .NET SDK dotnet 명령어를 쓰기 위한 SDK입니다.
dotnet restore

프로젝트에 필요한 패키지를 내려받습니다.

dotnet run

프로젝트를 빌드하고 바로 실행합니다.

dotnet run 실행 후 터미널에 나타나는 안내 메시지나 주소를 확인하세요.
// repository documentation