Skip to content

Introducing openapi doc under /docs path #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bestmazzo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Introducing openapi doc under /docs path #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,9 @@
},
"dependencies": {
"lru-cache": "^10.0.0",
"multer": "^1.4.5-lts.1"
"multer": "^1.4.5-lts.1",
"swagger-ui-express": "^5.0.0",
"yaml": "^2.3.1"
},
"peerDependencies": {
"bpmn-engine": ">=15",
Expand All @@ -71,6 +73,8 @@
"index.d.ts"
],
"c8": {
"include": ["src/"]
"include": [
"src/"
]
}
}
}
21 changes: 19 additions & 2 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { randomUUID } from 'node:crypto';
import { Router, json } from 'express';
import fs from 'node:fs';
import multer from 'multer';
import YAML from 'yaml'

import { STORAGE_TYPE_DEPLOYMENT, STORAGE_TYPE_FILE, STORAGE_TYPE_STATE, DEFAULT_IDLE_TIMER } from './constants.js';
import { MulterAdapterStorage } from './MulterAdapterStorage.js';
Expand All @@ -11,6 +12,7 @@ import { MemoryAdapter } from './MemoryAdapter.js';
import { HttpError } from './Errors.js';
import { MiddlewareEngine } from './MiddlewareEngine.js';
import { fromActivityApi } from './Caller.js';
import swaggerUi from "swagger-ui-express";

const packageInfo = fs.promises.readFile(join(process.cwd(), 'package.json')).then((content) => JSON.parse(content));
const kInitilialized = Symbol.for('initialized');
Expand Down Expand Up @@ -40,6 +42,21 @@ export function bpmnEngineMiddleware(options) {
initialized = true;
return middleware.init(req, res, next);
});
router.use(
"/docs",
swaggerUi.serve,
swaggerUi.setup(null, { explorer: true, swaggerUrl: '../openapi.json' })
);
var swaggerUiDoc = {}
packageInfo.then(p => {
let swaggerInfo = fs.readFileSync(join(process.cwd(), 'src/openapi.yml')).toString();
swaggerUiDoc = YAML.parse(swaggerInfo)
swaggerUiDoc.info.version = p.version
swaggerUiDoc.info.title = p.name
swaggerUiDoc.info.description = p.description
swaggerUiDoc.info.license.name = p.license
});
router.get('(*)?/openapi.json', (req, res) => { res.send(swaggerUiDoc) })
router.get('(*)?/version', middleware.getVersion);
router.get('(*)?/deployment', middleware.getDeployment);
router.post('(*)?/deployment/create', multer({ storage }).any(), middleware.create);
Expand Down Expand Up @@ -295,7 +312,7 @@ BpmnEngineMiddleware.prototype._startDeployment = async function startDeployment

BpmnEngineMiddleware.prototype._startProcessByCallActivity = function startProcessByCallActivity(callActivityApi) {
const { owner: activity, content } = callActivityApi;
const [ category, ...rest ] = content.calledElement.split(':');
const [category, ...rest] = content.calledElement.split(':');

if (category !== STORAGE_TYPE_DEPLOYMENT || !rest.length) return;
const deploymentName = rest.join(':');
Expand All @@ -313,7 +330,7 @@ BpmnEngineMiddleware.prototype._startProcessByCallActivity = function startProce
};

BpmnEngineMiddleware.prototype._cancelProcessByCallActivity = async function cancelProcessByCallActivity(callActivityApi) {
const [ category, ...rest ] = callActivityApi.content.calledElement.split(':');
const [category, ...rest] = callActivityApi.content.calledElement.split(':');

if (category !== STORAGE_TYPE_DEPLOYMENT || !rest.length) return;

Expand Down
Loading