@travetto/openapi 3.0.0-rc.25 → 3.0.0-rc.26
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 +9 -5
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
<!-- This file was generated by @travetto/doc and should not be modified directly -->
|
|
2
2
|
<!-- Please modify https://github.com/travetto/travetto/tree/main/module/openapi/DOC.ts and execute "npx trv doc" to rebuild -->
|
|
3
3
|
# OpenAPI Specification
|
|
4
|
-
## OpenAPI integration support for the
|
|
4
|
+
## OpenAPI integration support for the Travetto framework
|
|
5
5
|
|
|
6
6
|
**Install: @travetto/openapi**
|
|
7
7
|
```bash
|
|
8
8
|
npm install @travetto/openapi
|
|
9
|
+
|
|
10
|
+
# or
|
|
11
|
+
|
|
12
|
+
yarn add @travetto/openapi
|
|
9
13
|
```
|
|
10
14
|
|
|
11
15
|
In the [RESTful API](https://github.com/travetto/travetto/tree/main/module/rest#readme "Declarative api for RESTful APIs with support for the dependency injection module.") module, the controllers and endpoints can be described via decorators, comments, or typings. This only provides the general metadata internally. This is not sufficient to generate a usable API doc, and so this module exists to bridge that gap.
|
|
@@ -114,7 +118,7 @@ The framework, when in watch mode, will generate the [OpenAPI](https://github.co
|
|
|
114
118
|
|
|
115
119
|
## CLI - openapi:spec
|
|
116
120
|
|
|
117
|
-
The module provides a command for the [Command Line Interface](https://github.com/travetto/travetto/tree/main/module/cli#readme "CLI infrastructure for
|
|
121
|
+
The module provides a command for the [Command Line Interface](https://github.com/travetto/travetto/tree/main/module/cli#readme "CLI infrastructure for Travetto framework") to allow scripting file generation.
|
|
118
122
|
|
|
119
123
|
**Terminal: OpenAPI usage**
|
|
120
124
|
```bash
|
|
@@ -133,7 +137,7 @@ The command will run your application, in non-server mode, to collect all the ro
|
|
|
133
137
|
|
|
134
138
|
## CLI - openapi:client
|
|
135
139
|
|
|
136
|
-
The module provides a command for the [Command Line Interface](https://github.com/travetto/travetto/tree/main/module/cli#readme "CLI infrastructure for
|
|
140
|
+
The module provides a command for the [Command Line Interface](https://github.com/travetto/travetto/tree/main/module/cli#readme "CLI infrastructure for Travetto framework") to allow client generation from the API structure.
|
|
137
141
|
|
|
138
142
|
**Terminal: OpenAPI usage**
|
|
139
143
|
```bash
|
|
@@ -145,9 +149,9 @@ Options:
|
|
|
145
149
|
-x, --extended-help Show Extended Help
|
|
146
150
|
-a, --additional-properties <additional-properties> Additional Properties (default: [])
|
|
147
151
|
-i, --input <input> Input file (default:
|
|
148
|
-
"
|
|
152
|
+
"./openapi.yml")
|
|
149
153
|
-o, --output <output> Output folder (default:
|
|
150
|
-
"
|
|
154
|
+
"./api-client")
|
|
151
155
|
-d, --docker-image <docker-image> Docker Image to use (default:
|
|
152
156
|
"arcsine/openapi-generator:latest")
|
|
153
157
|
-w, --watch Watch for file changes
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@travetto/openapi",
|
|
3
|
-
"version": "3.0.0-rc.
|
|
4
|
-
"description": "OpenAPI integration support for the
|
|
3
|
+
"version": "3.0.0-rc.26",
|
|
4
|
+
"description": "OpenAPI integration support for the Travetto framework",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"rest",
|
|
7
7
|
"travetto",
|
|
@@ -26,14 +26,14 @@
|
|
|
26
26
|
"directory": "module/openapi"
|
|
27
27
|
},
|
|
28
28
|
"dependencies": {
|
|
29
|
-
"@travetto/config": "^3.0.0-rc.
|
|
30
|
-
"@travetto/rest": "^3.0.0-rc.
|
|
31
|
-
"@travetto/schema": "^3.0.0-rc.
|
|
32
|
-
"@travetto/yaml": "^3.0.0-rc.
|
|
29
|
+
"@travetto/config": "^3.0.0-rc.25",
|
|
30
|
+
"@travetto/rest": "^3.0.0-rc.26",
|
|
31
|
+
"@travetto/schema": "^3.0.0-rc.25",
|
|
32
|
+
"@travetto/yaml": "^3.0.0-rc.21",
|
|
33
33
|
"openapi3-ts": "^3.1.2"
|
|
34
34
|
},
|
|
35
35
|
"peerDependencies": {
|
|
36
|
-
"@travetto/cli": "^3.0.0-rc.
|
|
36
|
+
"@travetto/cli": "^3.0.0-rc.24"
|
|
37
37
|
},
|
|
38
38
|
"peerDependenciesMeta": {
|
|
39
39
|
"@travetto/cli": {
|