Skip to content
This repository was archived by the owner on Sep 17, 2025. It is now read-only.

Commit e0eaf63

Browse files
author
Phil Sturgeon
committed
Created a clear TODO for anyone looking
Linked to issues where they exist, and removed CLI usage (as it does not exist).
1 parent 1b8beb2 commit e0eaf63

1 file changed

Lines changed: 14 additions & 16 deletions

File tree

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,23 @@
44

55
A flow written in ES6 using Immutable to convert between API description formats (Swagger, etc.) and other programs such as cURL command lines.
66

7-
## What formats are supported and what will be in the future
7+
## Format Support
8+
89
We currently support:
9-
- `Swagger v2.0 (in/out)`
10-
- `RAML v1.0 (in/out)`
11-
- `Postman Collection v2.0 (in/out)`
12-
- `Paw v3.1 (in/out)`
10+
11+
- Swagger v2.0 (in/out)
12+
- RAML v1.0 (in/out)
13+
- Postman Collection v2.0 (in/out)
14+
- Paw v3.1 (in/out)
1315

1416
We intend to support:
15-
- `Swagger v3.0`
16-
- `RAML v0.8`
17-
- `Postman Collection v1.0`
18-
- `Postman Dump v1.0`
19-
- `Insomnia v3.0`
20-
- `Api-Blueprint`
17+
18+
- Swagger v3.0
19+
- RAML v0.8
20+
- Postman Collection v1.0
21+
- Postman Dump v1.0
22+
- Insomnia v3.0
23+
- API Blueprint
2124
- and many more.
2225

2326
## Installation
@@ -89,11 +92,6 @@ promise.then((data) => {
8992
})
9093
```
9194

92-
### Using as a CLI (coming soon)
93-
```sh
94-
node ./bin/api-flow.js some_swagger.json -f swagger -t raml > converted.yml
95-
```
96-
9795
### User Interface
9896

9997
API-Flow is one of the main components of [Console.REST](https://github.com/luckymarmot/console-rest). If you're an API user, you can easily use [https://console.rest/](https://console.rest/) to convert API description files. If you're an API provider, you can add a button to your API docs to let your users open and play with your API in client apps including Paw or Postman.

0 commit comments

Comments
 (0)