@tsed/cli-generate-swagger 4.4.1 → 4.4.3
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/package.json +3 -3
- package/readme.md +6 -5
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tsed/cli-generate-swagger",
|
|
3
|
-
"version": "4.4.
|
|
3
|
+
"version": "4.4.3",
|
|
4
4
|
"description": "Ts.ED CLI plugin. Export a command that generate the swagger.json from your Ts.ED controllers and OS3 spec.",
|
|
5
5
|
"source": "./src/index.ts",
|
|
6
6
|
"main": "./lib/cjs/index.js",
|
|
@@ -22,8 +22,8 @@
|
|
|
22
22
|
"tslib": "2.3.1"
|
|
23
23
|
},
|
|
24
24
|
"devDependencies": {
|
|
25
|
-
"@tsed/cli": "4.4.
|
|
26
|
-
"@tsed/cli-core": "4.4.
|
|
25
|
+
"@tsed/cli": "4.4.3",
|
|
26
|
+
"@tsed/cli-core": "4.4.3"
|
|
27
27
|
},
|
|
28
28
|
"peerDependencies": {
|
|
29
29
|
"@tsed/common": ">=7.14.2",
|
package/readme.md
CHANGED
|
@@ -25,19 +25,18 @@
|
|
|
25
25
|
</div>
|
|
26
26
|
|
|
27
27
|
|
|
28
|
-
> Ts.ED CLI plugin. Generate
|
|
28
|
+
> Ts.ED CLI plugin. Generate all Swagger in `json` and `yaml` format from your Ts.ED Server.
|
|
29
29
|
|
|
30
30
|
## Features
|
|
31
31
|
|
|
32
|
-
The plugin let you generate
|
|
33
|
-
Any changes from your controllers and models are reflected in your client!
|
|
32
|
+
The plugin let you generate all Swagger spec from the Ts.ED Server instance without running it.
|
|
34
33
|
|
|
35
34
|
## Installation
|
|
36
35
|
|
|
37
36
|
Run:
|
|
38
37
|
|
|
39
38
|
```bash
|
|
40
|
-
npm install @tsed/cli-generate-swagger @tsed/cli-core @tsed/cli @tsed/swagger
|
|
39
|
+
npm install @tsed/cli-generate-swagger @tsed/cli-core @tsed/cli @tsed/swagger
|
|
41
40
|
```
|
|
42
41
|
|
|
43
42
|
Then create or edit the `src/bin/index.ts` in your project:
|
|
@@ -69,6 +68,8 @@ Add a new script your `package.json`:
|
|
|
69
68
|
}
|
|
70
69
|
```
|
|
71
70
|
|
|
71
|
+
This command generate all Swagger specification in `json` and `yaml` format.
|
|
72
|
+
|
|
72
73
|
## Contributors
|
|
73
74
|
|
|
74
75
|
Please read [contributing guidelines here](https://tsed.io/CONTRIBUTING.html)
|
|
@@ -91,7 +92,7 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
|
|
|
91
92
|
|
|
92
93
|
The MIT License (MIT)
|
|
93
94
|
|
|
94
|
-
Copyright (c) 2016 -
|
|
95
|
+
Copyright (c) 2016 - 2023 Romain Lenzotti
|
|
95
96
|
|
|
96
97
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
97
98
|
|