Permalink
Please
sign in to comment.
Browse files
- Loading branch information
committed
Dec 3, 2019
0 parents
commit 25942359eba6796f8254c4ef2897ffae28fcb8aa
| @@ -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' |
| @@ -0,0 +1,20 @@ | ||
| <!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.2/bundles/redoc.standalone.js" async defer></script> | ||
| </body> | ||
| </html> | ||
|
|
Oops, something went wrong.
0 comments on commit
2594235