UNPKG

hapi-openapi

Version:

Design-driven apis with OpenAPI (formerly Swagger) 2.0 and hapi.

github.com/krakenjs/hapi-openapi

krakenjs/hapi-openapi

134 lines (77 loc) • 2.75 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
### 3.0.0 - Preliminary OpenAPI 3 support ### 2.0.2 - Don't set undefined parameters on request in `routeExt` (#180) - Update enjoi and @hapi/joi to Joi 17 (#176) ### 2.0.1 - Removed left over console.log file - Fixed `unknown` being used on all joi schemas as opposed to just objects ### 2.0.0 - [BREAKING] Upgraded hapi support to v19 and other dependencies (#173) ### 1.2.6 - Reduced package size ### 1.2.5 - Support api level security definitions #162 - Better cors support #159 ### 1.2.4 ### 1.2.3 - Fixes #156 - Fixes #153 - Fixes #152 ### 1.2.2 - Addresses #149: allow ignoring basePath for api docs path. ### 1.2.1 - Version bump for NPM security audit ### 1.2.0 - Vendor extensions are now stripped from the API docs end point (option `docs.stripExtensions`). - Bumped to Enjoi 4.x. ### 1.1.0 - Allow override of payload options via `x-hapi-options` (#137). ### 1.0.5 - Allow auth in doc options to be `false` (#134). ### 1.0.4 - Resolves https://github.com/krakenjs/hapi-openapi/issues/123, fixing array format support in parameters. ### 1.0.3 - Resolves https://github.com/krakenjs/hapi-openapi/issues/125, correcting `date-time` format. ### 1.0.2 - Allow registering multiple of this plugin. ### 1.0.1 - Fixes issue #117 (breaking on empty description). ### 1.0.0 Rename - Renamed to hapi-openapi. - Dropped version down to 1.0.0. ### 4.1.0 - Fixes trailing spaces #104. - Fixes empty base path #106. - Fixes no operation parameters #108. - Adds support for API as object instead of file path #102 ### 4.0.0 - [BREAKING] x-* attribute support renamed to x-hapi-*. - New support for `x-hapi-options` on operations. ### 3.4.2 - Updated to file validation which addresses #68. ### 3.4.1 - Upgraded `enjoi`. ### 3.4.0 - Added support for output validation (optional). ### 3.3.2 - Fixed YAML parsing for api-docs route. ### 3.3.1 - Fixed https://github.com/krakenjs/swaggerize-hapi/issues/72 - allow single item arrays. ### 3.3.0 - x-auth attribute support. - basedir is not an option (officially). ### 3.2.0 - x-handler attribute support. ### 3.1.0 - Add tags and description to routes based on API spec. - Don't restrict auth types. - Add route meta data from API spec. - `docspath` option is now `docs` and is an object. ### 3.0 - [BREAKING] Migrated to Hapi 17 and Node 8. - [BREAKING] Severed from `swaggerize-routes` - this module is now standalone. - [BREAKING] `server.plugins.swagger.api` is now `server.plugins.swagger.getApi()`. - [BREAKING] `handlers` object doesn't namespace http methods using `$` anymore. Assumption is verb is last in object path. - [BREAKING] Currently does not work with the `swaggerize-generator`. - Routes will specify what they allow based on api spec.