|
1 | 1 |
|
2 | 2 | <img src="https://voyager.postman.com/logo/postman-logo-orange.svg" width="320" alt="The Postman Logo">
|
3 | 3 |
|
4 |
| -*Supercharge your API workflow.* |
| 4 | +*Supercharge your API workflow.* |
5 | 5 | *Modern software is built on APIs. Postman helps you develop APIs faster.*
|
6 | 6 |
|
7 | 7 | # OpenAPI 3.0 to Postman Collection v2.1.0 Converter
|
8 | 8 |
|
9 |
| -[](https://travis-ci.org/postmanlabs/openapi-to-postman) |
10 |
| -<a href="https://www.npmjs.com/package/openapi-to-postmanv2" alt="Latest Stable Version"></a> |
| 9 | + |
| 10 | + |
| 11 | +<a href="https://www.npmjs.com/package/openapi-to-postmanv2" alt="Latest Stable Version"></a> |
11 | 12 | <a href="https://www.npmjs.com/package/openapi-to-postmanv2" alt="Total Downloads"></a>
|
12 | 13 |
|
13 |
| -#### Contents |
| 14 | +#### Contents |
14 | 15 |
|
15 | 16 | 1. [Getting Started](#getting-started)
|
16 | 17 | 2. [Using the converter as a NodeJS module](#using-the-converter-as-a-nodejs-module)
|
@@ -101,7 +102,7 @@ Check out complete list of options and their usage at [OPTIONS.md](/OPTIONS.md)
|
101 | 102 |
|
102 | 103 | ### ConversionResult
|
103 | 104 |
|
104 |
| -- `result` - Flag responsible for providing a status whether the conversion was successful or not |
| 105 | +- `result` - Flag responsible for providing a status whether the conversion was successful or not |
105 | 106 |
|
106 | 107 | - `reason` - Provides the reason for an unsuccessful conversion, defined only if result: false
|
107 | 108 |
|
@@ -160,28 +161,28 @@ The converter can be used as a CLI tool as well. The following [command line opt
|
160 | 161 | `openapi2postmanv2 [options]`
|
161 | 162 |
|
162 | 163 | ### Options
|
163 |
| -- `-v`, `--version` |
| 164 | +- `-v`, `--version` |
164 | 165 | Specifies the version of the converter
|
165 | 166 |
|
166 |
| -- `-s <source>`, `--spec <source>` |
| 167 | +- `-s <source>`, `--spec <source>` |
167 | 168 | Used to specify the OpenAPI specification (file path) which is to be converted
|
168 | 169 |
|
169 |
| -- `-o <destination>`, `--output <destination>` |
| 170 | +- `-o <destination>`, `--output <destination>` |
170 | 171 | Used to specify the destination file in which the collection is to be written
|
171 | 172 |
|
172 |
| -- `-t`, `--test` |
| 173 | +- `-t`, `--test` |
173 | 174 | Used to test the collection with an in-built sample specification
|
174 | 175 |
|
175 |
| -- `-p`, `--pretty` |
| 176 | +- `-p`, `--pretty` |
176 | 177 | Used to pretty print the collection object while writing to a file
|
177 | 178 |
|
178 | 179 | - `-O`, `--options`
|
179 | 180 | Used to supply options to the converter, for complete options details see [here](/OPTIONS.md)
|
180 | 181 |
|
181 |
| -- `-c`, `--options-config` |
| 182 | +- `-c`, `--options-config` |
182 | 183 | Used to supply options to the converter through config file, for complete options details see [here](/OPTIONS.md)
|
183 | 184 |
|
184 |
| -- `-h`, `--help` |
| 185 | +- `-h`, `--help` |
185 | 186 | Specifies all the options along with a few usage examples on the terminal
|
186 | 187 |
|
187 | 188 |
|
|
0 commit comments