File tree Expand file tree Collapse file tree 1 file changed +14
-6
lines changed Expand file tree Collapse file tree 1 file changed +14
-6
lines changed Original file line number Diff line number Diff line change 1
- # API- Platform Documentation parsing check
1
+ # API Platform Documentation Parsing Check
2
2
3
3
[ ![ Build Status] ( https://travis-ci.org/api-platform/api-platform-doc-parsing-check.svg?branch=master )] ( https://travis-ci.org/api-platform/api-platform-doc-parsing-check )
4
4
[ ![ npm version] ( https://badge.fury.io/js/%40api-platform%2Fapi-platform-doc-parsing-check.svg )] ( https://badge.fury.io/js/%40api-platform%2Fapi-platform-doc-parsing-check )
5
5
[ ![ MIT Licence] ( https://badges.frapsoft.com/os/mit/mit.svg?v=103 )] ( https://opensource.org/licenses/mit-license.php )
6
6
7
+ Simple CLI app to check your API Platform's API documentation prior to run the frontend tools:
7
8
8
- Simple CLI app to check your API-Platform api documentation prior running front-end tools:
9
- 1 . @api-platform/client-generator
10
- 2 . @api-platform/admin
9
+ 1 . [ The Alient Generator Component] ( https://api-platform.com/docs/client-generator )
10
+ 2 . [ The Admin Component] ( https://api-platform.com/docs/admin )
11
11
12
- This tool is using @api-platform/api-doc-parser library that front-end tools depend on.
12
+ This tool is using the [ API Doc Parser library] ( https://github.com/api-platform/api-doc-parser ) that frontend tools depend on.
13
+
14
+ ## Install
15
+
16
+ yarn add @api-platform/api-platform-doc-parsing-check
17
+
18
+ ## Usage
19
+
20
+ node_modules/@api-platform/api-platform-doc-parsing-check/lib/index.js http://localhost:8080/
13
21
14
22
Check Result:
15
23
16
- ![ paraing ] ( screen.png )
24
+ ![ Result ] ( screen.png )
You can’t perform that action at this time.
0 commit comments