Create temp REST API reference (#766)

conda-incubator · Mar 15, 2024 · 991c780 · 991c780
1 parent d345670
commit 991c780
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 9 deletions.
diff --git a/docusaurus-docs/conda-store/references/api.md b/docusaurus-docs/conda-store/references/api.md
diff --git a/docusaurus-docs/conda-store/references/api.mdx b/docusaurus-docs/conda-store/references/api.mdx
@@ -0,0 +1,16 @@
+---
+description: REST API reference
+---
+
+# REST API reference
+
+conda-store-server includes a REST API created using FastAPI.
+The API reference is available at [conda.store/rest-api.html](/rest-api.html),
+and it is embedded below as an inline frame.
+
+<iframe
+    title="conda-store-ui components"
+    src={`/rest-api.html`}
+    width="100%"
+    height="600"
+></iframe>
diff --git a/docusaurus-docs/static/openapi.json b/docusaurus-docs/static/openapi.json
diff --git a/docusaurus-docs/static/rest-api.html b/docusaurus-docs/static/rest-api.html
@@ -0,0 +1,31 @@
+<!--
+Generated using static/openapi.json - a copy of the autogenerated spec by FastAPI, ref: https://fastapi.tiangolo.com/features/#automatic-docs
+Presented using Swagger UI, ref: https://swagger.io/tools/swagger-ui/
+-->
+
+<html>
+    <head>
+        <title>conda-store REST API</title>
+        <link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css">
+        <script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js"></script>
+    </head>
+    <body>
+        <!-- Render the Swagger UI -->
+        <div id="swagger-ui"></div>
+
+        <!-- https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/ -->
+        <script>
+            const ui = SwaggerUIBundle({
+            url: `openapi.json`,
+            dom_id: '#swagger-ui',
+            presets: [
+                SwaggerUIBundle.presets.apis,
+                SwaggerUIBundle.SwaggerUIStandalonePreset
+            ],
+            layout: "BaseLayout",
+            tryItOutEnabled: false,
+            supportedSubmitMethods: [],
+            });
+        </script>
+    </body>
+</html>