Skip to content

Commit b6edf2d

Browse files
committed
Updated readme
1 parent 0e83ff2 commit b6edf2d

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,21 +82,25 @@ Important versions listed below. Refer to the [Changelog](CHANGELOG.md) for a fu
8282

8383
Following command can be used to generate DTOs and Api clients for the [nem2-sdk-typescript-javascript](https://github.com/nemtech/nem2-sdk-typescript-javascript) :
8484

85-
1.
85+
1. Download latest NEM2 swagger definition
8686
```bash
8787
$ git clone git@github.com:nemtech/nem2-docs
8888
$ cd nem2-docs && mkdir sdks && cd sdks
8989
$ cp ../source/resources/collections/swagger.yaml .
9090
```
91-
2. Copy the `templates` folder from {nem2-sdk-typescript-javascript}/infrustructure/ into `sdk` folder
91+
2. Copy OpenAPI generator template
92+
93+
Copy the `templates` folder from {nem2-sdk-typescript-javascript}/infrastructure/ into `sdk` folder
9294

93-
3.
95+
3. Download OpenAPI generator and generate codes
9496
```bash
9597
$ brew install openapi-generator
9698
$ openapi-generator generate -i ./swagger2.yaml -g typescript-node -t templates/ -o ./nem2-ts-sdk/ && rm -R nem2-ts-sdk/test
9799
```
98100
** Note openapi-generator is also available on docker. (`https://hub.docker.com/r/openapitools/openapi-generator`)
99-
4. As the generator doesn't recognize `enum` type alias, we need to manually move enum classes in to the `enumsMap` list.
101+
4. Fix enum type definitions
102+
103+
As the generator doesn't recognize `enum` type alias, we need to manually move enum classes in to the `enumsMap` list.
100104
- Open generated file `./nem2-ts-sdk/model/models.ts` in editor
101105
- Search for line contains `let enumsMap: {[index: string]: any}`.
102106
- Move all `xxxTypeEnum` entries from below `typeMap` into `enumsMap`.

0 commit comments

Comments
 (0)