@flink-app/api-docs-plugin 1.0.0 → 2.0.0-alpha.48
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/dist/index.js +3 -2
- package/package.json +6 -2
package/CHANGELOG.md
CHANGED
package/dist/index.js
CHANGED
|
@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
exports.apiDocPlugin = void 0;
|
|
7
|
+
var express_1 = __importDefault(require("express"));
|
|
7
8
|
var path_1 = __importDefault(require("path"));
|
|
8
9
|
var apiDocPlugin = function (options) {
|
|
9
10
|
if (options === void 0) { options = {}; }
|
|
@@ -20,8 +21,8 @@ function init(app, options) {
|
|
|
20
21
|
throw new Error("Express app not initialized");
|
|
21
22
|
}
|
|
22
23
|
var staticPath = path_1.default.resolve(__dirname, "react-app");
|
|
23
|
-
expressApp
|
|
24
|
-
expressApp
|
|
24
|
+
expressApp.use(options.path || "/docs", express_1.default.static(staticPath));
|
|
25
|
+
expressApp.get(options.apiPath || "/docs/api", function (req, res) {
|
|
25
26
|
var sortedHandlers = handlers.sort(function (routeA, routeB) { return routeA.routeProps.path.localeCompare(routeB.routeProps.path); });
|
|
26
27
|
res.json({ routes: sortedHandlers });
|
|
27
28
|
});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flink-app/api-docs-plugin",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "2.0.0-alpha.48",
|
|
4
4
|
"description": "Flink plugin that generates API documentation based on JSON schemas",
|
|
5
5
|
"files": [
|
|
6
6
|
"dist/**/*",
|
|
@@ -10,11 +10,15 @@
|
|
|
10
10
|
"license": "MIT",
|
|
11
11
|
"types": "dist/index.d.ts",
|
|
12
12
|
"main": "dist/index.js",
|
|
13
|
+
"dependencies": {
|
|
14
|
+
"express": "^4.21.2"
|
|
15
|
+
},
|
|
13
16
|
"devDependencies": {
|
|
17
|
+
"@types/express": "^4.17.21",
|
|
14
18
|
"@types/node": "22.13.10",
|
|
15
19
|
"ts-node": "^10.9.2",
|
|
16
20
|
"tsc-watch": "^4.2.9",
|
|
17
|
-
"@flink-app/flink": "
|
|
21
|
+
"@flink-app/flink": "2.0.0-alpha.48"
|
|
18
22
|
},
|
|
19
23
|
"gitHead": "4243e3b3cd6d4e1ca001a61baa8436bf2bbe4113",
|
|
20
24
|
"scripts": {
|