-
Notifications
You must be signed in to change notification settings - Fork 16
/
widdershins.node_cli.txt
90 lines (85 loc) · 7.34 KB
/
widdershins.node_cli.txt
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
WIDDERSHINS
ALTERNATIVES ==> ##To HTML:
## - OpenAPI 2.0, 3.0:
## - swagger-ui (best text documentation and most well-known but UI is not great)
## - most high-profile
## - React|Redux-based
## - can change spec, logo, deep linking, requests testing, authentication, JSON request samples
## - one-column, ok design, a bit non-user-friendly and ugly. Very non-mobile-friendly.
## - misses: the least features of all, but not far from redoc
## - redoc (pretty good but widdershins is better)
## - high-profile
## - React|Redux-based
## - can change spec, search, logo, deep linking, multi-language request samples
## - three-columns, pretty
## - misses: a little more than swagger-ui
## - OpenAPI 3.0:
## - open-api-renderer:
## - less maintained
## - React|Redux-based
## - can change spec, deep linking
## - one-column, not very pretty
## - misses: not checked
## - OpenAPI 2.0:
## - dapperdox:
## - less maintained
## - logo, requests testing, authentication, deep linking, guides
## - one-column, separated into several pages, not very pretty
## - not mobile-friendly
## - misses: not checked
## - pretty-swag:
## - less maintained
## - search, requests testing, JSON request samples
## - one-column, ok design
## - misses: not checked
## - swagger-codegen "html" template:
## - less maintained, less feature
## - does not look great
##To HTML|Markdown:
## - OpenAPI 2.0, 3.0:
## - widdershins (best UI and has Markdown support):
## - search, logo, deep linking, multi-language request samples
## - three-columns, pretty
## - misses: a bit more than swagger-ui or redoc
## - OpenAPI 2.0:
## - spectacle:
## - logo, deep linking, JSON request samples
## - three-columns, pretty
## - misses: not checked
##To Markdown:
## - OpenAPI 2.0:
## - swagger2markup: less maintained
## - swagger-markdown: less maintained, misses much info
MISSING OPENAPI PROPERTIES ## - swagger-ui|redoc|widdershins:
==> ## - important:
## - OpenAPI 2.0, 3.0: SCHEMA.minItems|maxItems|uniqueItems, SCHEMA.additionalProperties|minProperties|maxProperties, SCHEMA.allowEmptyValue, SCHEMA.readOnly
## - OpenAPI 3.0: PARAM.content|examples, CONTENT.encoding|example[s]
## - less important:
## - OpenAPI 2.0, 3.0: SCHEMA.title|externalDocs|xml
## - OpenAPI 2.0: SCHEMA.discriminator
## - OpenAPI 3.0: PATHDEF.summary|description, STYLE_PROPS, SCHEMA.oneOf|anyOf|not|writeOnly|deprecated|nullable|discriminator
## - swagger-ui:
## - important:
## - OpenAPI 2.0, 3.0: SCHEMA.format
## - OpenAPI 3.0: SECURITY_DEF 'openIdConnect'
## - less important:
## - OpenAPI 2.0, 3.0: OPERATION.operationId, SCHEMA.multipleOf
## - OpenAPI 2.0: OPERATION.schemes
## - OpenAPI 3.0: SERVER[.variables].description, LINK.requestBody|server, SECURITY_DEF.bearerFormat, OAUTH2.refreshUrl
## - redoc:
## - important:
## - OpenAPI 3.0: CALLBACK, RESP.content, LINK
## - less important:
## - OpenAPI 2.0, 3.0: TAGS|OPERATION.externalDocs, OPERATION.operationId, SCHEMA.multipleOf
## - OpenAPI 2.0: SCHEMA.collectionFormat, RESP.examples (but generates fake from RESP.schema)
## - OpenAPI 3.0: SERVER.variables|description, PATHDEF.trace, PATHDEF.servers, REQ_BODY.required|description, STATUS_CODE 2XX|3XX|4XX|5XX
## - widdershins:
## - important:
## - OpenAPI 2.0, 3.0: OPERATION.deprecated, SCHEMA.default, SCHEMA.multipleOf|[exclusive]minimum|maximum, SCHEMA.minLength|maxLength|pattern
## - OpenAPI 3.0: PARAM.deprecated, RESP.content, LINK, SECURITY_DEF 'openIdConnect'
## - less important:
## - OpenAPI 2.0, 3.0: OPERATION.externalDocs
## - OpenAPI 2.0: OPERATION.schemes, SCHEMA.collectionFormat, RESP.examples (but generates fake from RESP.schema)
## - OpenAPI 3.0: SERVER.description, PATHDEF|OPERATION.servers, SECURITY_DEF.bearerFormat, OAUTH2.refreshUrl