Skip to content

Commit c4e49b6

Browse files
authored
Update README.md
1 parent e53e63f commit c4e49b6

File tree

1 file changed

+14
-23
lines changed

1 file changed

+14
-23
lines changed

README.md

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -55,28 +55,12 @@ _**Note:** Ensure express is configured with all relevant body parsers. body par
5555

5656
## Advanced Usage
5757

58-
For authentication, see securityHandlers in [Options](#Options).
59-
60-
For OpenAPI 3.0.x 3rd party and custom formats, see [Options](#Options).
61-
62-
#### Optionally inline the spec...
63-
64-
The `apiSpec` option may be specified as the spec object itself, rather than a path e.g.
65-
66-
```javascript
67-
const apiSpec = {
68-
openapi: "3.0.1",
69-
info: {...},
70-
servers: [...],
71-
paths: {...},
72-
components: {
73-
responses: {...},
74-
schemas: {...}
75-
}
76-
}
77-
78-
new OpenApiValidator({ apiSpec }).install(app);
79-
```
58+
See [Options](#Options) below to:
59+
- inline api specs as JSON.
60+
- tweak the file upload configuration.
61+
- customize authentication with `securityHandlers`.
62+
- use OpenAPI 3.0.x 3rd party and custom formats.
63+
- and more...
8064

8165
## Options
8266

@@ -111,7 +95,14 @@ or
11195

11296
```javascript
11397
apiSpec: {
114-
// the openapi specification as JSON
98+
openapi: '3.0.1',
99+
info: {...},
100+
servers: [...],
101+
paths: {...},
102+
components: {
103+
responses: {...},
104+
schemas: {...}
105+
}
115106
}
116107
```
117108

0 commit comments

Comments
 (0)