|
1 | 1 | # Node generator for Node-RED |
2 | 2 |
|
3 | | -Node generator is command line tool to generate Node-RED node modules from a number of different sources including Swagger specification and function node's source. |
| 3 | +Node generator is command line tool to generate Node-RED node modules from several various sources including Swagger specification and function node's source. |
4 | 4 | Using this tool, node developers can dramatically reduce their time to implement Node-RED node modules. |
5 | 5 |
|
6 | 6 | ## Installation |
@@ -34,28 +34,34 @@ You may need to run this with `sudo`, or from within an Administrator command sh |
34 | 34 | --tgz : Save node as tgz file |
35 | 35 | --help : Show help |
36 | 36 |
|
37 | | -### Example 1. Create original node from function node (JavaScript code) |
| 37 | +### Example 1. Create original node from Swagger definition |
38 | 38 |
|
39 | | -- On Node-RED flow editor, save function node to library with file name (lower-case.js). |
40 | | -- node-red-nodegen ~/.node-red/lib/function/lower-case.js |
41 | | -- cd node-red-contrib-lower-case |
| 39 | +- node-red-nodegen http://petstore.swagger.io/v2/swagger.json |
| 40 | +- cd node-red-contrib-swagger-petstore |
42 | 41 | - sudo npm link |
43 | 42 | - cd ~/.node-red |
44 | | -- npm link node-red-contrib-lower-case |
| 43 | +- npm link node-red-contrib-swagger-petstore |
45 | 44 | - node-red |
46 | 45 |
|
47 | | --> You can use lower-case node on Node-RED flow editor. |
| 46 | +-> You can use swagger-petstore node on Node-RED flow editor. |
48 | 47 |
|
49 | | -### Example 2. Create original node from Swagger definition |
| 48 | +### Example 2. Create original node from function node (JavaScript code) |
50 | 49 |
|
51 | | -- node-red-nodegen http://petstore.swagger.io/v2/swagger.json |
52 | | -- cd node-red-contrib-swagger-petstore |
| 50 | +- On Node-RED flow editor, save function node to library with file name (lower-case.js). |
| 51 | +- node-red-nodegen ~/.node-red/lib/function/lower-case.js |
| 52 | +- cd node-red-contrib-lower-case |
53 | 53 | - sudo npm link |
54 | 54 | - cd ~/.node-red |
55 | | -- npm link node-red-contrib-swagger-petstore |
| 55 | +- npm link node-red-contrib-lower-case |
56 | 56 | - node-red |
57 | 57 |
|
58 | | --> You can use swagger-petstore node on Node-RED flow editor. |
| 58 | +-> You can use lower-case node on Node-RED flow editor. |
59 | 59 |
|
60 | | -Note: Currently node generator supports GET and POST methods using JSON format without authentication. |
| 60 | +## Documentation |
| 61 | +- [Use cases](docs/index.md#use-cases) ([Japanese](docs/index_ja.md#use-cases)) |
| 62 | +- [How to use Node generator](docs/index.md#how-to-use-node-generator) ([Japanese](docs/index_ja.md#how-to-use-node-generator)) |
| 63 | +- [Generated files which node package contains](docs/index.md#generated-files-which-node-package-contains) ([Japanese](docs/index_ja.md#generated-files-which-node-package-contains)) |
| 64 | +- [How to create node from Swagger definition](docs/index.md#how-to-create-node-from-swagger-definition) ([Japanese](docs/index_ja.md#how-to-create-node-from-swagger-definition)) |
| 65 | +- [How to create node from function node](docs/index.md#how-to-create-node-from-function-node) ([Japanese](docs/index_ja.md#how-to-create-node-from-function-node)) |
61 | 66 |
|
| 67 | +Note: Currently node generator supports GET and POST methods using JSON format without authentication. |
0 commit comments