Skip to content

Commit

Permalink
Update QuickStart.md (Azure#21405)
Browse files Browse the repository at this point in the history
* Update QuickStart.md

* Update QuickStart.md
  • Loading branch information
leni-msft authored and anandanthony committed Dec 16, 2022
1 parent 3f43e9f commit ac4621d
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions documentation/api-scenario/how-to/QuickStart.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ npm install -g oav
- Validation result report. After each run API scenario, developer will get a validation report which contains detected issue in API test.
- Integrate everywhere. Easily integrate with azure-pipeline, cloud-test.

See `oav run -h` to find all available options.
Run `oav run -h` to find all available options.

## Create AAD app

Expand Down Expand Up @@ -104,20 +104,22 @@ The `env.json` file contains required API scenario variables such as, subscripti

```json
{
"subscriptionId": "<my subscription id>",
"subscriptionId": "<your subscription id>",
"location": "westcentralus",
"tenantId": "<AAD app tenantId>",
"client_id": "<my add client_id>",
"client_secret": "<my aad client_secret>"
"client_id": "<your add client_id>",
"client_secret": "<your aad client_secret>"
}
```

#### 3. Run API Scenario test

```sh
oav run ~/workspace/azure-rest-api-specs/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/scenarios/quickstart.yaml --tag=package-2022-05-01 -e env.json --verbose
oav run ~/workspace/azure-rest-api-specs/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/scenarios/quickstart.yaml --tag package-2022-05-01 -e env.json --verbose
```

The `--tag` parameter specifies tag name in the autorest configuration (readme.md) file, and Swagger files under the tag will be loaded. By default, oav tries to find the closest readme.md file in the upper directories of the scenario file, and use the "default" tag in it. You can use `--readme` and `--tag` to specify readme.md file and tag to load Swagger files, or `--specs` to specify Swagger files directly.

#### 4. Debug with Postman

Sometimes the command `oav run` may fail due to non 2xx HTTP status code. Now you need to debug the API scenario with Postman.
Expand Down

0 comments on commit ac4621d

Please sign in to comment.