[WIP] DX OpenAPI

.vitepress/config.ts

@@ -20,6 +20,8 @@ import {
   SwagColorCodingConfig
 } from "../../developer-documentation-vitepress/src/shopware/config";
 
+import {navigation as apisNavigation} from "./navigation/apis";
+
 const sections: SwagSectionsConfig[] = [
   {
     title: 'Frontends',
@@ -298,7 +300,12 @@ export default defineConfigWithTheme<ThemeConfig>({
   ignoreDeadLinks: true,
 
   themeConfig: {
-    ...navigation, // add sidebar and nav config
+    sidebar: {
+      ...navigation.sidebar,
+      ...apisNavigation,
+    },
+    nav: navigation.nav,
+    // ...navigation, // add sidebar and nav config
 
     algolia: {
       indexName: "beta-developer-shopware",

.vitepress/theme/index.ts

@@ -1,12 +1,16 @@
 import {SWAGTheme} from "vitepress-shopware-docs";
 import SwagRadialBg from "../../src/components/SwagRadialBg.vue";
+import OpenApi from "../../src/components/OpenApi.vue";
 
 export default {
     ...SWAGTheme({
         slots: {
             'layout-bottom': [
                 SwagRadialBg,
             ]
+        },
+        enhanceApp({app}) {
+            app.component('OpenApi', OpenApi);
         }
     }),
 }

src/[api]-api.md

@@ -0,0 +1,3 @@
+# {{ $params.api }}
+
+<!-- @content -->

src/[api]-api.paths.js

@@ -0,0 +1,14 @@
+export default {
+    paths() {
+        return [
+            {
+                params: {api: 'store'},
+                content: 'This is content',
+            },
+            {
+                params: {api: 'admin'},
+                content: 'This is custom content',
+            }
+        ]
+    }
+}

src/api.md

@@ -0,0 +1,9 @@
+---
+aside: false
+sidebar: false
+---
+<script setup lang="ts">
+import OpenApiViewer from "./components/OpenAPIViewer.vue";
+</script>
+
+<OpenApiViewer />

src/api/admin/endpoint/[method]-[path].md

@@ -0,0 +1,9 @@
+# {{ $params.slug }}
+
+<OpenApi api="admin" :endpoint="$params.path" :method="$params.method" />
+
+Test: {{ $params.slug }}
+
+{{ $params }}
+
+<!-- @content -->

src/api/admin/endpoint/[method]-[path].paths.js

@@ -0,0 +1,7 @@
+import {makePaths} from "../../helpers";
+
+export default {
+    paths() {
+        return makePaths('admin');
+    }
+}

src/api/admin/scheme/[slug].md

@@ -0,0 +1,3 @@
+# {{ $params.api }}
+
+<!-- @content -->

src/api/admin/scheme/[slug].paths.js

@@ -0,0 +1,14 @@
+export default {
+    paths() {
+        return [
+            {
+                params: {slug: 'store'},
+                content: 'This is content',
+            },
+            {
+                params: {slug: 'admin'},
+                content: 'This is custom content',
+            }
+        ]
+    }
+}

src/api/helpers.ts

@@ -0,0 +1,30 @@
+import adminApi from "../components/adminapi.json";
+import storeApi from "../components/storeapi.json";
+
+export const makePaths = (api: string) => {
+    const data = {
+        admin: adminApi,
+        store: storeApi,
+    }[api] || null;
+
+    if (!data) {
+        throw "Incorrect api";
+    }
+
+    return Object.keys(adminApi.paths)
+        .reduce((reduced, path) => {
+            return Object.keys(adminApi.paths[path])
+                .reduce((reduced, method) => {
+                    reduced.push({
+                        path: path.split('/')
+                            .splice(1)
+                            .join('-')
+                            .replace('{', '')
+                            .replace('}', ''),
+                        method: method.toLowerCase(),
+                    });
+                    return reduced;
+                }, reduced);
+        }, [])
+        .map(route => ({params: {...route,}, content: ''}))
+}

src/api/store/endpoint/[slug].md

@@ -0,0 +1,3 @@
+# {{ $params.api }}
+
+<!-- @content -->

src/api/store/endpoint/[slug].paths.js

@@ -0,0 +1,14 @@
+export default {
+    paths() {
+        return [
+            {
+                params: {slug: 'store'},
+                content: 'This is content',
+            },
+            {
+                params: {slug: 'admin'},
+                content: 'This is custom content',
+            }
+        ]
+    }
+}

src/api/store/scheme/[slug].md

@@ -0,0 +1,3 @@
+# {{ $params.api }}
+
+<!-- @content -->

src/api/store/scheme/[slug].paths.js

@@ -0,0 +1,14 @@
+export default {
+    paths() {
+        return [
+            {
+                params: {slug: 'store'},
+                content: 'This is content',
+            },
+            {
+                params: {slug: 'admin'},
+                content: 'This is custom content',
+            }
+        ]
+    }
+}