You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,20 @@
1
1
# nem2-openapi-generator-dart
2
-
This is an OpenAPI generator for Dart (v2 and above) which allow generation of NEM2 API client libraries for NEM2 SDK Dart ([nem2-sdk-dart][nem2-sdk-dart-repo]) automatically given a NEM2 OpenAPI Spec ([nem2-openapi][nem2-openapi-spec-repo]).
2
+
This is an OpenAPI generator for Dart (v2 and above) which allows generation of NEM2 API client libraries for NEM2 SDK Dart ([nem2-sdk-dart][nem2-sdk-dart-repo]) automatically given a NEM2 OpenAPI Spec ([nem2-openapi][nem2-openapi-spec-repo]).
3
3
4
4
## Requirements
5
5
An [OpenAPI Generator CLI][openapi-generator-cli-docs] for your Operating System is required to generate the client libraries.
6
6
The code generation script uses Homebrew by default and it will install the openapi-generator-cli when it has not been installed.
7
7
8
-
If you want to install and use the OpenAPI generator without using Homebrew, then you can disable the line inside the generator script that checks and installs it.
8
+
If you want to install and use the OpenAPI generator without using Homebrew, then you can disable the line inside the code generation script that checks and installs it.
9
9
10
10
## Usage
11
-
Run the generator script:
11
+
Run the code generation script:
12
12
```$bash
13
13
./generate.sh
14
14
```
15
15
16
16
## Configuration
17
-
The generator uses a custom configuration file `openapi-config.yaml` available for Dart. Please refer to the following page for a complete list of config options: [here][openapi-genrator-dart2-configs].
17
+
The OpenAPI generator uses a custom configuration file `openapi-config.yaml` available for Dart. Please refer to the following page for a complete list of config options: [here][openapi-genrator-dart2-configs].
18
18
19
19
## Version
20
20
This project is updated for NEM2 OpenAPI specification version [0.7.20][nem2-openapi-spec-file].
0 commit comments