Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
justinyoo committed Jul 12, 2020
1 parent 2f5ac93 commit 20e5a36
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions docs/openapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,33 @@ This enables Azure Functions to render Open API document and Swagger UI. The mor

This is the easiest way to integrate the Open API document rendering. Run the following script based on your preference, which will install the pre-defined Open API document rendering endpoints.

#### Download Installation Scripts ###

First of all, download the installation script from GitHub.

```powershell
# PowerShell
(Invoke-WebRequest `
-Uri "https://raw.githubusercontent.com/aliencube/AzureFunctions.Extensions/dev/scripts/Install-OpenApiHttpTriggerTemplates.ps1" `
-UseBasicParsing).Content | Out-File "scripts/Install-OpenApiHttpTriggerTemplates.ps1"
```

```bash
# Bash
curl -X GET "https://raw.githubusercontent.com/aliencube/AzureFunctions.Extensions/dev/scripts/Install-OpenApiHttpTriggerTemplates.sh" > "scripts/Install-OpenApiHttpTriggerTemplates.sh"
```

For bash script, run the following command to enable an appropriate permission.

```bash
# Bash
chmod +x scripts/Download-OpenApiHttpTriggerTemplates.sh
```

#### Install Open API Templates ####

Run the following script to install the Open API templates.

```powershell
# PowerShell
scripts/Install-OpenApiHttpTriggerTemplates.ps1 `
Expand All @@ -35,8 +62,6 @@ scripts/Install-OpenApiHttpTriggerTemplates.sh \
Aliencube.AzureFunctions.FunctionAppV3Static
```

> **NOTE**: You may need to run `chmod +x scripts/Download-OpenApiHttpTriggerTemplates.sh` command.
However, if you want to manually integrate by yourself, follow the next steps.


Expand Down

0 comments on commit 20e5a36

Please sign in to comment.