Merge branch 'feature/52-alternative_openapi_viewers' of git.odit.services:lfk/backend into feature/52-alternative_openapi_viewers

Added very basic api doc chooser
ref #52
2020-12-23 15:11:17 +01:00 · 2020-12-23 15:11:14 +01:00
4 changed files with 30 additions and 5 deletions
--- a/.gitignore
+++ b/.gitignore
@ -132,5 +132,5 @@ build

 *.sqlite
 *.sqlite-jurnal
-docs
+/docs
 lib
--- a/src/loaders/openapi.ts
+++ b/src/loaders/openapi.ts
@ -1,5 +1,6 @@
 import { validationMetadatasToSchemas } from "class-validator-jsonschema";
-import { Application } from "express";
+import express, { Application } from "express";
+import path from 'path';
 import { getMetadataArgsStorage } from "routing-controllers";
 import { routingControllersToSpec } from "routing-controllers-openapi";
 import * as swaggerUiExpress from "swagger-ui-express";
@ -51,12 +52,13 @@ export default async (app: Application) => {
    explorer: true,
  };
  app.use(
-    "/api/docs",
+    "/api/docs/swagger",
    swaggerUiExpress.serve,
    swaggerUiExpress.setup(spec, options)
  );
-  app.get(["/api/openapi.json", "/api/swagger.json"], (req, res) => {
+  app.get(["/api/docs/openapi.json", "/api/docs/swagger.json"], (req, res) => {
    res.json(spec);
  });
+  app.use('/api/docs', express.static(path.join(__dirname, '../static/docs'), { index: "index.html", extensions: ['html'] }));
  return app;
 };
--- a/src/openapi_export.ts
+++ b/src/openapi_export.ts
@ -36,7 +36,14 @@ const spec = routingControllersToSpec(
                "AuthToken": {
                    "type": "http",
                    "scheme": "bearer",
-                    "bearerFormat": "JWT"
+                    "bearerFormat": "JWT",
+                    description: "A JWT based access token. Use /api/auth/login or /api/auth/refresh to get one."
+                },
+                "RefreshTokenCookie": {
+                    "type": "apiKey",
+                    "in": "cookie",
+                    "name": "lfk_backend__refresh_token",
+                    description: "A cookie containing a JWT based refreh token. Attention: Doesn't work in swagger-ui. Use /api/auth/login or /api/auth/refresh to get one."
                }
            }
        },
--- a/src/static/docs/index.html
+++ b/src/static/docs/index.html
@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<h1>Pick your poison</h1>
+<ul>
+    <li>
+        <a href="./redoc">ReDoc</a>
+    </li>
+    <li>
+        <a href="./swagger">SwaggerUI</a>
+    </li>
+    <li>
+        <a href="./rapidoc">RapiDoc</a>
+    </li>
+    <li>
+        <a href="./openapi.json">Raw Spec (json)</a>
+    </li>
+</ul>
Author	SHA1	Message	Date
Nicolai Ort	bd46a48f76	Merge branch 'feature/52-alternative_openapi_viewers' of git.odit.services:lfk/backend into feature/52-alternative_openapi_viewers	2020-12-23 15:11:17 +01:00
Nicolai Ort	ebedea97ed	Added very basic api doc chooser ref #52	2020-12-23 15:11:14 +01:00