Skip to content
This repository was archived by the owner on Mar 8, 2025. It is now read-only.

Commit 5445d2e

Browse files
author
dnphu
committed
[Document] Init README
1 parent 742e1f7 commit 5445d2e

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Lite Express Swagger
2+
3+
## Description
4+
---
5+
Lite Express Swagger is a package built by typescript and an open-source project that helps expressjs application to easily build swagger
6+
documentation.\
7+
This package provides flexibility and lite functionality to build swagger document and not using the raw json
8+
to build it.
9+
10+
## Getting started
11+
---
12+
Firstly you need to initialize your documentation by defining in this way:
13+
```javascript
14+
const document = new DocumentBuilder()
15+
.setInfo({
16+
title: 'Express application',
17+
version: '1.0',
18+
// Below fields are optional
19+
description: 'Description';
20+
termsOfService: 'http://swagger.io/terms/';
21+
contact: {
22+
name: 'Phu';
23+
24+
};
25+
license: {
26+
name: 'Apache 2.0';
27+
url: 'http://www.apache.org/licenses/LICENSE-2.0.html';
28+
};
29+
})
30+
```

0 commit comments

Comments
 (0)