Skip to content

Commit 57f0f45

Browse files
committed
docs: add step in usage
1 parent c53d0be commit 57f0f45

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,16 @@ yarn add @didik-mulyadi/nodejs-api-docs
2727

2828
## Usage 💻
2929

30+
Here's an example of how to use this package:
31+
3032
## nodejs-api-doc with @nest/swagger
3133

32-
Here's an example of how to use this package:
34+
Step:
35+
36+
1. Create a swagger config with `new DocumentBuilder()`
37+
2. Generate open api document object with `SwaggerModule.createDocument(app, config)`
38+
3. Setup nodejs-api-doc with `new NodejsApiDoc`
39+
4. Start nodejs-api-doc with `nodejsApiDoc.start()`
3340

3441
```typescript
3542
// src/main.ts

0 commit comments

Comments
 (0)