Merge pull request #34 from arifszn/33-redoc

Add Redoc to display OpenAPI spec in website
arifszn · Sep 1, 2022 · d0a42d4 · d0a42d4
2 parents 217687a + 4f7d995
commit d0a42d4
Show file tree

Hide file tree

Showing 9 changed files with 1,774 additions and 56 deletions.
diff --git a/README.md b/README.md
@@ -54,6 +54,8 @@
 
 -   [Dockerized](https://arifszn.github.io/pandora/docs/installation#with-docker-sail)
 -   [OpenAPI Specification](https://arifszn.github.io/pandora/docs/features/openapi-specification)
+-   [Swagger UI](https://arifszn.github.io/pandora/docs/api-documentation/swagger-ui)
+-   [Redoc](https://arifszn.github.io/pandora/docs/api-documentation/redoc)
 -   [Service Repository Pattern](https://arifszn.github.io/pandora/docs/features/service-repository-pattern)
 -   [API Resource](https://arifszn.github.io/pandora/docs/features/api-resource)
 -   [Code Style & Lint](https://arifszn.github.io/pandora/docs/features/code-style-and-lint)

diff --git a/app/Http/Controllers/PandoraController.php b/app/Http/Controllers/PandoraController.php
@@ -3,13 +3,17 @@
 namespace App\Http\Controllers;
 
 use Illuminate\Foundation\Application;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Response;
 
 class PandoraController extends Controller
 {
-    public function index()
+    /**
+     * @return JsonResponse
+     */
+    public function index(): JsonResponse
     {
         $response['status'] = 'ok';
 

diff --git a/website/docs/1-introduction.md b/website/docs/1-introduction.md
@@ -55,6 +55,8 @@ hide_title: true
 
 - [Dockerized](/docs/installation#with-docker-sail)
 - [OpenAPI Specification](/docs/features/openapi-specification)
+- [Swagger UI](/api-documentation/swagger-ui)
+- [Redoc](/api-documentation/redoc)
 - [Service Repository Pattern](/docs/features/service-repository-pattern)
 - [API Resource](/docs/features/api-resource)
 - [Code Style & Lint](/docs/features/code-style-and-lint)

diff --git a/website/docs/3-api-documentation/1-swagger-ui.md b/website/docs/3-api-documentation/1-swagger-ui.md
@@ -4,12 +4,7 @@ hide_title: true
 hide_table_of_contents: true
 ---
 
-import SwaggerUI from "swagger-ui-react"
-import "swagger-ui-react/swagger-ui.css"
+import SwaggerUI from "swagger-ui-react";
+import "swagger-ui-react/swagger-ui.css";
 
-<SwaggerUI 
-    url="https://raw.githubusercontent.com/arifszn/pandora/main/public/openapi.yaml"
-    persistAuthorization={true}
-    displayOperationId={true}
-    filter={true}
-/>
+<SwaggerUI url="https://raw.githubusercontent.com/arifszn/pandora/main/public/openapi.yaml" persistAuthorization={true} displayOperationId={true} filter={true} />
diff --git a/website/docs/3-api-documentation/2-redoc.md b/website/docs/3-api-documentation/2-redoc.md
@@ -0,0 +1,9 @@
+---
+title: Redoc
+hide_title: true
+hide_table_of_contents: true
+---
+
+import ApiDocMdx from '@theme/ApiDocMdx';
+
+<ApiDocMdx id="redoc-nested" />
diff --git a/website/docs/3-api-documentation/_category_.json b/website/docs/3-api-documentation/_category_.json
@@ -1,5 +1,11 @@
 {
   "label": "API Documentation",
   "collapsible": true,
-  "collapsed": false
+  "collapsed": false,
+  "link": {
+    "type": "generated-index",
+    "title": "API Documentation",
+    "description": "All the available APIs are documented with OpenAPI Specification. The documentation can be viewed in Swagger UI or Redoc.",
+    "slug": "/api-documentation"
+  }
 }
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -48,6 +48,21 @@ const config = {
         },
       }),
     ],
+    [
+      'redocusaurus',
+      {
+        specs: [
+          {
+            id: 'redoc-nested',
+            spec: 'https://raw.githubusercontent.com/arifszn/pandora/main/public/openapi.yaml',
+          },
+        ],
+        theme: {
+          primaryColor: '#6f32be',
+          primaryColorDark: '#8c65bd',
+        },
+      },
+    ],
   ],
 
   themeConfig: