Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Travis CI User
committed
Sep 23, 2020
0 parents
commit 75a3d5c
Showing
3 changed files
with
2,869 additions
and
0 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # API Specification | ||
|
|
||
| The specification is written using [Swagger 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) (known today as OpenAPI). | ||
|
|
||
| # How to | ||
|
|
||
| ## Preview a local specification file | ||
|
|
||
| Serve the content of this directory through any HTTP server, for instance: | ||
|
|
||
| ``` | ||
| $ python -m SimpleHTTPServer | ||
| Serving HTTP on 0.0.0.0 port 8000 ... | ||
| ``` | ||
|
|
||
| ``` | ||
| $ python3 -m http.server | ||
| Serving HTTP on 0.0.0.0 port 8000 ... | ||
| ``` | ||
|
|
||
| Then, browse your localhost on port 8000. | ||
|
|
||
|
|
||
| ## Preview a specification file hosted on a remote machine | ||
|
|
||
| - Visit https://rebilly.github.io/ReDoc/ | ||
| - Provide a URL to the spec file | ||
| - Click on 'TRY IT' |
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 @@ | ||
| <!doctype html> | ||
| <html lang="en"> | ||
| <head> | ||
| <title>Cardano Wallet Backend API Documentation</title> | ||
| <meta charset="utf-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
| <meta name="description" content="Swagger-generated API Reference Documentation for Cardano Wallet Backend API" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
| <meta property="og:title" content="Cardano Wallet Backend API Documentation" /> | ||
| <meta property="og:description" content="Swagger-generated API Reference Documentation for Cardano Wallet Backend API" /> | ||
| <meta property="og:image" content="https://cardanodocs.com/img/cardano.png" /> | ||
| <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet"> | ||
| <style> body { margin: 0; padding: 0; } </style> | ||
| </head> | ||
| <body> | ||
| <redoc spec-url="./swagger.yaml"></redoc> | ||
| <script src="https://cdn.jsdelivr.net/npm/redoc@2.0.0-rc.23/bundles/redoc.standalone.js" async defer></script> | ||
| </body> | ||
| </html> |
Oops, something went wrong.