Skip to content

Commit 43d0753

Browse files
committed
Link to openapi and hydra websites
1 parent 003b49b commit 43d0753

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![npm version](https://badge.fury.io/js/%40api-platform%2Fclient-generator.svg)](https://badge.fury.io/js/%40api-platform%2Fclient-generator)
55
[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)
66

7-
API Platform Client Generator is a generator to scaffold app with Create-Retrieve-Update-Delete features for any API exposing a Hydra or Swagger documentation for:
7+
API Platform Client Generator is a generator to scaffold app with Create-Retrieve-Update-Delete features for any API exposing a [Hydra](http://www.hydra-cg.com/spec/latest/core/) or [OpenAPI](https://www.openapis.org/) documentation for:
88
* React/Redux
99
* React Native
1010
* Vue.js
@@ -22,12 +22,18 @@ The documentation of API Platform's Client Generator can be browsed [on the offi
2222
npx @api-platform/client-generator https://demo.api-platform.com/ output/ --resource Book
2323
```
2424

25-
**OpenAPI** (experimental)
25+
**OpenAPI v2 (formerly known as Swagger)** (experimental)
2626
```sh
2727
npx @api-platform/client-generator https://demo.api-platform.com/docs.json output/ --resource Book --format swagger
2828
```
2929

30-
**Swagger** (experimental)
30+
or
31+
32+
```sh
33+
npx @api-platform/client-generator https://demo.api-platform.com/docs.json output/ --resource Book --format openapi2
34+
```
35+
36+
**OpenAPI v3** (experimental)
3137
```sh
3238
npx @api-platform/client-generator https://demo.api-platform.com/docs.json?spec_version=3 output/ --resource Book --format openapi3
3339
```

0 commit comments

Comments
 (0)