forked from techschool/simplebank
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add static swagger documentation page to the server (techschool#36)
Co-authored-by: phamlequang <[email protected]>
- Loading branch information
1 parent
5ead2d2
commit 0181a5a
Showing
29 changed files
with
1,153 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| html { | ||
| box-sizing: border-box; | ||
| overflow: -moz-scrollbars-vertical; | ||
| overflow-y: scroll; | ||
| } | ||
|
|
||
| *, | ||
| *:before, | ||
| *:after { | ||
| box-sizing: inherit; | ||
| } | ||
|
|
||
| body { | ||
| margin: 0; | ||
| background: #fafafa; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| <!-- HTML for static distribution bundle build --> | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <title>Swagger UI</title> | ||
| <link rel="stylesheet" type="text/css" href="./swagger-ui.css" /> | ||
| <link rel="stylesheet" type="text/css" href="index.css" /> | ||
| <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" /> | ||
| <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" /> | ||
| </head> | ||
|
|
||
| <body> | ||
| <div id="swagger-ui"></div> | ||
| <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script> | ||
| <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script> | ||
| <script src="./swagger-initializer.js" charset="UTF-8"> </script> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| <!doctype html> | ||
| <html lang="en-US"> | ||
| <head> | ||
| <title>Swagger UI: OAuth2 Redirect</title> | ||
| </head> | ||
| <body> | ||
| <script> | ||
| 'use strict'; | ||
| function run () { | ||
| var oauth2 = window.opener.swaggerUIRedirectOauth2; | ||
| var sentState = oauth2.state; | ||
| var redirectUrl = oauth2.redirectUrl; | ||
| var isValid, qp, arr; | ||
|
|
||
| if (/code|token|error/.test(window.location.hash)) { | ||
| qp = window.location.hash.substring(1); | ||
| } else { | ||
| qp = location.search.substring(1); | ||
| } | ||
|
|
||
| arr = qp.split("&"); | ||
| arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';}); | ||
| qp = qp ? JSON.parse('{' + arr.join() + '}', | ||
| function (key, value) { | ||
| return key === "" ? value : decodeURIComponent(value); | ||
| } | ||
| ) : {}; | ||
|
|
||
| isValid = qp.state === sentState; | ||
|
|
||
| if (( | ||
| oauth2.auth.schema.get("flow") === "accessCode" || | ||
| oauth2.auth.schema.get("flow") === "authorizationCode" || | ||
| oauth2.auth.schema.get("flow") === "authorization_code" | ||
| ) && !oauth2.auth.code) { | ||
| if (!isValid) { | ||
| oauth2.errCb({ | ||
| authId: oauth2.auth.name, | ||
| source: "auth", | ||
| level: "warning", | ||
| message: "Authorization may be unsafe, passed state was changed in server Passed state wasn't returned from auth server" | ||
| }); | ||
| } | ||
|
|
||
| if (qp.code) { | ||
| delete oauth2.state; | ||
| oauth2.auth.code = qp.code; | ||
| oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl}); | ||
| } else { | ||
| let oauthErrorMsg; | ||
| if (qp.error) { | ||
| oauthErrorMsg = "["+qp.error+"]: " + | ||
| (qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") + | ||
| (qp.error_uri ? "More info: "+qp.error_uri : ""); | ||
| } | ||
|
|
||
| oauth2.errCb({ | ||
| authId: oauth2.auth.name, | ||
| source: "auth", | ||
| level: "error", | ||
| message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server" | ||
| }); | ||
| } | ||
| } else { | ||
| oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl}); | ||
| } | ||
| window.close(); | ||
| } | ||
|
|
||
| if (document.readyState !== 'loading') { | ||
| run(); | ||
| } else { | ||
| document.addEventListener('DOMContentLoaded', function () { | ||
| run(); | ||
| }); | ||
| } | ||
| </script> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,205 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "title": "Simple Bank API", | ||
| "version": "1.1", | ||
| "contact": { | ||
| "name": "Tech School", | ||
| "url": "https://github.com/techschool", | ||
| "email": "[email protected]" | ||
| } | ||
| }, | ||
| "tags": [ | ||
| { | ||
| "name": "SimpleBank" | ||
| } | ||
| ], | ||
| "consumes": [ | ||
| "application/json" | ||
| ], | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "paths": { | ||
| "/v1/create_user": { | ||
| "post": { | ||
| "summary": "Create new user", | ||
| "description": "Use this API to create a new user", | ||
| "operationId": "SimpleBank_CreateUser", | ||
| "responses": { | ||
| "200": { | ||
| "description": "A successful response.", | ||
| "schema": { | ||
| "$ref": "#/definitions/pbCreateUserResponse" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "An unexpected error response.", | ||
| "schema": { | ||
| "$ref": "#/definitions/rpcStatus" | ||
| } | ||
| } | ||
| }, | ||
| "parameters": [ | ||
| { | ||
| "name": "body", | ||
| "in": "body", | ||
| "required": true, | ||
| "schema": { | ||
| "$ref": "#/definitions/pbCreateUserRequest" | ||
| } | ||
| } | ||
| ], | ||
| "tags": [ | ||
| "SimpleBank" | ||
| ] | ||
| } | ||
| }, | ||
| "/v1/login_user": { | ||
| "post": { | ||
| "summary": "Login user", | ||
| "description": "Use this API to login user and get access token \u0026 refresh token", | ||
| "operationId": "SimpleBank_LoginUser", | ||
| "responses": { | ||
| "200": { | ||
| "description": "A successful response.", | ||
| "schema": { | ||
| "$ref": "#/definitions/pbLoginUserResponse" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "An unexpected error response.", | ||
| "schema": { | ||
| "$ref": "#/definitions/rpcStatus" | ||
| } | ||
| } | ||
| }, | ||
| "parameters": [ | ||
| { | ||
| "name": "body", | ||
| "in": "body", | ||
| "required": true, | ||
| "schema": { | ||
| "$ref": "#/definitions/pbLoginUserRequest" | ||
| } | ||
| } | ||
| ], | ||
| "tags": [ | ||
| "SimpleBank" | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "pbCreateUserRequest": { | ||
| "type": "object", | ||
| "properties": { | ||
| "username": { | ||
| "type": "string" | ||
| }, | ||
| "fullName": { | ||
| "type": "string" | ||
| }, | ||
| "email": { | ||
| "type": "string" | ||
| }, | ||
| "password": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "pbCreateUserResponse": { | ||
| "type": "object", | ||
| "properties": { | ||
| "user": { | ||
| "$ref": "#/definitions/pbUser" | ||
| } | ||
| } | ||
| }, | ||
| "pbLoginUserRequest": { | ||
| "type": "object", | ||
| "properties": { | ||
| "username": { | ||
| "type": "string" | ||
| }, | ||
| "password": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "pbLoginUserResponse": { | ||
| "type": "object", | ||
| "properties": { | ||
| "user": { | ||
| "$ref": "#/definitions/pbUser" | ||
| }, | ||
| "sessionId": { | ||
| "type": "string" | ||
| }, | ||
| "accessToken": { | ||
| "type": "string" | ||
| }, | ||
| "refreshToken": { | ||
| "type": "string" | ||
| }, | ||
| "accessTokenExpiresAt": { | ||
| "type": "string", | ||
| "format": "date-time" | ||
| }, | ||
| "refreshTokenExpiresAt": { | ||
| "type": "string", | ||
| "format": "date-time" | ||
| } | ||
| } | ||
| }, | ||
| "pbUser": { | ||
| "type": "object", | ||
| "properties": { | ||
| "username": { | ||
| "type": "string" | ||
| }, | ||
| "fullName": { | ||
| "type": "string" | ||
| }, | ||
| "email": { | ||
| "type": "string" | ||
| }, | ||
| "passwordChangedAt": { | ||
| "type": "string", | ||
| "format": "date-time" | ||
| }, | ||
| "createdAt": { | ||
| "type": "string", | ||
| "format": "date-time" | ||
| } | ||
| } | ||
| }, | ||
| "protobufAny": { | ||
| "type": "object", | ||
| "properties": { | ||
| "@type": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "additionalProperties": {} | ||
| }, | ||
| "rpcStatus": { | ||
| "type": "object", | ||
| "properties": { | ||
| "code": { | ||
| "type": "integer", | ||
| "format": "int32" | ||
| }, | ||
| "message": { | ||
| "type": "string" | ||
| }, | ||
| "details": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/protobufAny" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| window.onload = function() { | ||
| //<editor-fold desc="Changeable Configuration Block"> | ||
|
|
||
| // the following lines will be replaced by docker/configurator, when it runs in a docker-container | ||
| window.ui = SwaggerUIBundle({ | ||
| url: "simple_bank.swagger.json", | ||
| dom_id: '#swagger-ui', | ||
| deepLinking: true, | ||
| presets: [ | ||
| SwaggerUIBundle.presets.apis, | ||
| SwaggerUIStandalonePreset | ||
| ], | ||
| plugins: [ | ||
| SwaggerUIBundle.plugins.DownloadUrl | ||
| ], | ||
| layout: "StandaloneLayout" | ||
| }); | ||
|
|
||
| //</editor-fold> | ||
| }; |
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.