Skip to content

Commit 3b380dd

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 03b6fa1 commit 3b380dd

File tree

1 file changed

+26
-19
lines changed

1 file changed

+26
-19
lines changed

README.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,30 @@ A flow written in ES6 using Immutable to convert between API description formats
66

77
## What formats are supported and what will be in the future
88
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)`
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)
1313

1414
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`
15+
16+
- Swagger v3.0
17+
- RAML v0.8
18+
- Postman Collection v1.0
19+
- Postman Dump v1.0
20+
- Insomnia v3.0
21+
- API Blueprint
2122
- and many more.
2223

2324
## Installation
2425

25-
You can install this library in two different ways.
26+
You can install this library in two different ways.
2627

27-
### Install via NPM/Yarn
28+
### Install via NPM/Yarn
2829

2930
```shell
3031
$ yarn add api-flow
31-
# or
32+
# or
3233
$ npm install api-flow
3334
```
3435

@@ -88,11 +89,6 @@ promise.then((data) => {
8889
})
8990
```
9091

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

9894
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.
@@ -102,8 +98,19 @@ API-Flow is one of the main components of [Console.REST](https://github.com/luck
10298
PRs are welcomed!
10399
Our sole requirement is that organizations that want to extend API-Flow to support their format write both a parser and a serializer, and not simply a serializer.
104100

101+
## TODO
102+
103+
- Create CLI ([#146](https://github.com/luckymarmot/API-Flow/issues/146))
104+
- Add more formats:
105+
- [ ] API Blueprint
106+
- [ ] Swagger v3.0 ([#102](https://github.com/luckymarmot/API-Flow/issues/102))
107+
- [ ] Postman Collection v1.0
108+
- [ ] Postman Dump v1.0
109+
- [ ] Insomnia v3.0 ([#136](https://github.com/luckymarmot/API-Flow/pull/136))
110+
105111
## Documentation
106-
You can find more information about the internal structure of API-Flow in [src](https://github.com/luckymarmot/API-Flow/tree/develop/src). We've also created a set of templates to help speed up the extension process: [loader](https://github.com/luckymarmot/API-Flow/tree/develop/src/loaders/template/v1.0), [parser](https://github.com/luckymarmot/API-Flow/tree/develop/src/parsers/template/v1.0/), and [environment](https://github.com/luckymarmot/API-Flow/tree/develop/src/environments/template)
112+
113+
You can find more information about the internal structure of API-Flow in [src](src). We've also created a set of templates to help speed up the extension process: [loader](src/loaders/template/v1.0), [parser](parsers/template/v1.0/), and [environment](environments/template)
107114

108115
## License
109116

0 commit comments

Comments
 (0)