@hazeljs/swagger 0.7.8 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -12
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -306,7 +306,7 @@ SwaggerModule.forRoot({
|
|
|
306
306
|
title: 'My API',
|
|
307
307
|
description: 'Comprehensive API documentation',
|
|
308
308
|
version: '1.0.0',
|
|
309
|
-
|
|
309
|
+
|
|
310
310
|
// Server info
|
|
311
311
|
servers: [
|
|
312
312
|
{
|
|
@@ -318,29 +318,29 @@ SwaggerModule.forRoot({
|
|
|
318
318
|
description: 'Production server',
|
|
319
319
|
},
|
|
320
320
|
],
|
|
321
|
-
|
|
321
|
+
|
|
322
322
|
// Contact info
|
|
323
323
|
contact: {
|
|
324
324
|
name: 'API Support',
|
|
325
325
|
email: 'support@example.com',
|
|
326
326
|
url: 'https://example.com/support',
|
|
327
327
|
},
|
|
328
|
-
|
|
328
|
+
|
|
329
329
|
// License
|
|
330
330
|
license: {
|
|
331
331
|
name: 'Apache-2.0',
|
|
332
332
|
url: 'https://www.apache.org/licenses/LICENSE-2.0',
|
|
333
333
|
},
|
|
334
|
-
|
|
334
|
+
|
|
335
335
|
// Terms of service
|
|
336
336
|
termsOfService: 'https://example.com/terms',
|
|
337
|
-
|
|
337
|
+
|
|
338
338
|
// External docs
|
|
339
339
|
externalDocs: {
|
|
340
340
|
description: 'Find more info here',
|
|
341
341
|
url: 'https://docs.example.com',
|
|
342
342
|
},
|
|
343
|
-
|
|
343
|
+
|
|
344
344
|
// Security schemes
|
|
345
345
|
security: [
|
|
346
346
|
{
|
|
@@ -356,7 +356,7 @@ SwaggerModule.forRoot({
|
|
|
356
356
|
name: 'X-API-Key',
|
|
357
357
|
},
|
|
358
358
|
],
|
|
359
|
-
|
|
359
|
+
|
|
360
360
|
// Swagger UI options
|
|
361
361
|
swaggerOptions: {
|
|
362
362
|
persistAuthorization: true,
|
|
@@ -364,16 +364,16 @@ SwaggerModule.forRoot({
|
|
|
364
364
|
filter: true,
|
|
365
365
|
showExtensions: true,
|
|
366
366
|
},
|
|
367
|
-
|
|
367
|
+
|
|
368
368
|
// Path to serve docs
|
|
369
369
|
path: '/api-docs',
|
|
370
|
-
|
|
370
|
+
|
|
371
371
|
// Custom CSS
|
|
372
372
|
customCss: '.swagger-ui .topbar { display: none }',
|
|
373
|
-
|
|
373
|
+
|
|
374
374
|
// Custom site title
|
|
375
375
|
customSiteTitle: 'My API Documentation',
|
|
376
|
-
})
|
|
376
|
+
});
|
|
377
377
|
```
|
|
378
378
|
|
|
379
379
|
## Authentication
|
|
@@ -581,4 +581,4 @@ Apache 2.0 © [HazelJS](https://hazeljs.ai)
|
|
|
581
581
|
- [Swagger UI](https://swagger.io/tools/swagger-ui/)
|
|
582
582
|
- [GitHub](https://github.com/hazel-js/hazeljs)
|
|
583
583
|
- [Issues](https://github.com/hazel-js/hazeljs/issues)
|
|
584
|
-
- [Discord](https://discord.
|
|
584
|
+
- [Discord](https://discord.gg/PxNBPzvQk7)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hazeljs/swagger",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.8.0",
|
|
4
4
|
"description": "Swagger/OpenAPI documentation module for HazelJS framework",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -51,5 +51,5 @@
|
|
|
51
51
|
"peerDependencies": {
|
|
52
52
|
"@hazeljs/core": ">=0.2.0-beta.0"
|
|
53
53
|
},
|
|
54
|
-
"gitHead": "
|
|
54
|
+
"gitHead": "e0ed98ca074dd4f7472816d3c32ef576900dcca6"
|
|
55
55
|
}
|