aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2019-05-07 17:28:48 -0700
committerBryan Newbold <bnewbold@robocracy.org>2019-05-07 17:28:53 -0700
commit738fffd79c3fcc0e66c32ab95247b0cffde76e37 (patch)
tree42381e18be3f219799faf9b96f9f3aaeb067bdc4
parentc5c42b22c4b78027a2b43335ce9c747e95a5683e (diff)
downloadfatcat-bnewbold-redoc.tar.gz
fatcat-bnewbold-redoc.zip
WIP: commit old redoc notes/filesbnewbold-redoc
This is an alternative to the Swagger UI (for auto API docs)
-rw-r--r--extra/redoc/README.md8
-rw-r--r--extra/redoc/index.html25
2 files changed, 33 insertions, 0 deletions
diff --git a/extra/redoc/README.md b/extra/redoc/README.md
new file mode 100644
index 00000000..3a6ac937
--- /dev/null
+++ b/extra/redoc/README.md
@@ -0,0 +1,8 @@
+
+Need to set CORS on https://api.fatcat.wiki/v0/fatcat-openapi2.yml (?)
+
+File does seem to work:
+
+ http://rebilly.github.io/ReDoc/?url=https://api.fatcat.wiki/v0/openapi2.yml
+
+Bunch of config options. Should add more descriptions to swagger file.
diff --git a/extra/redoc/index.html b/extra/redoc/index.html
new file mode 100644
index 00000000..dc5fad86
--- /dev/null
+++ b/extra/redoc/index.html
@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <title>ReDoc</title>
+ <!-- needed for adaptive design -->
+ <meta charset="utf-8"/>
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
+
+ <!--
+ ReDoc doesn't change outer page styles
+ -->
+ <style>
+ body {
+ margin: 0;
+ padding: 0;
+ }
+ </style>
+ </head>
+ <body>
+ <!-- <redoc spec-url='https://api.fatcat.wiki/v0/openapi2.yml'></redoc> -->
+ <redoc spec-url='../../fatcat-openapi2.yml'></redoc>
+ <script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
+ </body>
+</html>