Skip to content

Commit 1e75130

Browse files
committed
docs: add example usage
1 parent d54b589 commit 1e75130

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,16 @@ yarn add @didik-mulyadi/nodejs-api-doc
2727

2828
## Usage 💻
2929

30+
After we setup the package correctly, we can switch the UI in your docs with this. <br/>
31+
32+
Example the path is `/docs
33+
34+
1. Use Swagger UI, `/docs?ui=swagger`
35+
2. Use Stoplight UI, `/docs?ui=stoplight`
36+
3. Use Redoc UI, `/docs?ui=redoc`
37+
38+
## Implementation 💻
39+
3040
Here's an example of how to use this package:
3141

3242
## nodejs-api-doc with @nest/swagger

0 commit comments

Comments
 (0)