2 |
3 | # MrinDoc
4 | An OpenAPI 3.0 and 2.0 Spec viewer with built in console
5 |
6 | ### [Demo](https://mrin9.github.io/OpenAPI-Viewer)
7 |
8 | ### Checkout RapiDoc - Another project for Viewing OpenAPI spec using web-Componnet
9 | #### [Checkout RapiDoc](https://mrin9.github.io/RapiDoc)
10 |
11 | # Features
12 | - Supports Swagger V2.0 and OpenAPI 3.0
13 | - Supports searching of end-points (paths)
14 | - Built In console to try out APIs
15 | - Responsive (support for desktop and tablets)
16 | - Supports Authentication
17 | - OAuth2
18 | - API Key(Token)
19 | - HTTP Bearer
20 | - HTTP Basic
21 | - UX friendly.
22 | - All Endpoints paths are cleanly presented
23 | - Clear seperation of Request and Response info laid out side by side in a two colum layout
24 | - Lesser clicks to deal with. All schema models, response-jsons and examples are expanded by defaults which eliminates the need of click and reveal each level.
25 | - While using API console, request data is pre-filled based on schema
26 | - Needs just one click to try out live APIs
27 |
28 |
29 | ## Project Build
30 | ```
31 | yarn install
32 | yarn run build
33 | ```
34 | ### Screenshots
35 | #### EndPoint Listings
36 |
37 | 
38 |
39 |
40 | #### Request/Response
41 | Laid out in a two colum for easy view & compare
42 |
43 | 
44 |
45 |
46 | #### Schema View
47 | All Request/Response schema and Response JSONs are expanded by default, so that you dont have to click and reveal each level for easy browsing and read
48 |
49 | 
50 |
51 |
52 | #### Console
53 | Built in console, fields are pre-filled with values if exist in spec, request body is generated and filled based on schema, allowing you to quickly try out the end-point with a single click
54 |
55 | 
56 |
57 |
58 | #### Authentication Support
59 | All the authentication methods are supported. Along with instructions on how to use it
60 |
61 | 
62 |
63 |
64 | 
65 |
66 |
67 |
--------------------------------------------------------------------------------
/babel.config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | presets: [
3 | '@vue/app'
4 | ],
5 | "plugins": [
6 | [
7 | "component",
8 | {
9 | "libraryName": "element-ui",
10 | "styleLibraryName": "theme-chalk"
11 | }
12 | ]
13 | ]
14 | }
15 |
16 |
--------------------------------------------------------------------------------
/deploy.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | # abort on errors
4 | set -e
5 |
6 | # build
7 | yarn build
8 |
9 | # navigate into the build output directory
10 | cd dist
11 |
12 | git init
13 | git add -A
14 | git commit -m 'deploy'
15 |
16 | # if you are deploying to https://|
9 | *{{param.name}}
10 |
11 | |
12 |
13 |
14 |
15 |
16 |
17 | |
43 |
44 |
45 |
46 |
47 |
48 |
49 | {{ param.schema.pattern? "Pattern: " + param.schema.pattern : "" }}
50 |
51 |
52 | |
53 |
| Type | 8 |Authentication Procedure | 9 |||||
|---|---|---|---|---|---|
|
12 | {{scheme.type}} {{scheme.scheme?scheme.scheme:""}}
13 |
14 | |
15 |
16 |
17 |
18 | If Activated, all requests will send '{{scheme.name}}' in '{{scheme.in}}' with the given value
19 |
20 |
21 |
22 |
23 | |
24 |
25 |
26 |
27 | If Activated, all requests will send 'Authorization'
28 | header that contains the word 'Basic' followed by a space and a base64-encoded string username:password.
29 |
30 |
31 |
32 |
33 |
34 | |
35 |
36 | If Activated, all requests will send 'Authorization'
37 | header that contains the word 'Bearer' followed by a space and a Token String.
38 |
39 |
40 |
41 |
43 | Once activated, this token will be sent in 'Authorization' header of every request
42 | |
44 |
45 |
46 |
47 | Auth URL:
48 | {{flow.authorizationUrl}} Token URL:
49 | {{flow.tokenUrl}} Refresh URL:
50 |
51 | Scopes:
52 | {{flow.refreshUrl}}
53 | {{scopeName}},
54 |
55 |
56 |
57 |
58 |
59 |
60 |
61 | Directions: Register this client with
62 | {{ getOAuthBaseUrl(flow.authorizationUrl) }}
|
68 | 69 | {{ scheme.type }} 70 | | 71 |