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
+10-17Lines changed: 10 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,37 +33,30 @@ Here's an example of how to use this package:
33
33
34
34
Step:
35
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()`
36
+
1. Modify your `src/main.ts`
37
+
2. Create a swagger config with `new DocumentBuilder()`
38
+
3. Generate open api document object with `SwaggerModule.createDocument(app, config)`
39
+
4. Setup nodejs-api-doc with `new NodejsApiDoc`
40
+
5. Start nodejs-api-doc with `nodejsApiDoc.start()`
40
41
41
42
```typescript
42
-
// src/main.ts
43
-
// define the app
44
-
45
-
// Define the swagger config
43
+
// swagger
46
44
const config =newDocumentBuilder()
47
-
.setTitle('Tyre Repair Assessment API')
48
-
.setDescription(
49
-
'This API provides a comprehensive tyre repair assessment. It analyzes the condition of a tyre and provides recommendations for repair or replacement based on a variety of factors, such as tread depth, punctures, and wear patterns.'
0 commit comments