You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/api-scenario/how-to/QuickStart.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ npm install -g oav
24
24
- Validation result report. After each run API scenario, developer will get a validation report which contains detected issue in API test.
25
25
- Integrate everywhere. Easily integrate with azure-pipeline, cloud-test.
26
26
27
-
See`oav run -h` to find all available options.
27
+
Run`oav run -h` to find all available options.
28
28
29
29
## Create AAD app
30
30
@@ -104,20 +104,22 @@ The `env.json` file contains required API scenario variables such as, subscripti
104
104
105
105
```json
106
106
{
107
-
"subscriptionId": "<my subscription id>",
107
+
"subscriptionId": "<your subscription id>",
108
108
"location": "westcentralus",
109
109
"tenantId": "<AAD app tenantId>",
110
-
"client_id": "<my add client_id>",
111
-
"client_secret": "<my aad client_secret>"
110
+
"client_id": "<your add client_id>",
111
+
"client_secret": "<your aad client_secret>"
112
112
}
113
113
```
114
114
115
115
#### 3. Run API Scenario test
116
116
117
117
```sh
118
-
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
118
+
oav run ~/workspace/azure-rest-api-specs/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/scenarios/quickstart.yaml --tagpackage-2022-05-01 -e env.json --verbose
119
119
```
120
120
121
+
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.
122
+
121
123
#### 4. Debug with Postman
122
124
123
125
Sometimes the command `oav run` may fail due to non 2xx HTTP status code. Now you need to debug the API scenario with Postman.
0 commit comments