Skip to content
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.

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

Fix: APAP template and agreement identifier improvements #14 #29

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
35 changes: 30 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,14 @@
"devDependencies": {
"@accordproject/concerto-cli": "^3.4.0",
"@ibm-cloud/openapi-ruleset": "^0.44.3",
"@types/uuid": "^10.0.0",
"ibm-openapi-validator": "^0.96.4",
"openapi-typescript": "^6.1.0",
"reslate": "^3.0.0-5",
"swagger-combine": "^1.4.0",
"widdershins": "^4.0.1"
},
"dependencies": {
"uuid": "^11.1.0"
}
}
102 changes: 74 additions & 28 deletions server/index.ts
Original file line number Diff line number Diff line change
@@ -1,48 +1,94 @@
import 'source-map-support/register';
import OpenAPIBackend, { Request } from 'openapi-backend';
import Express from 'express';
import morgan from 'morgan'
import path from 'path';
import "source-map-support/register";
import OpenAPIBackend, { Request } from "openapi-backend";
import Express from "express";
import morgan from "morgan";
import path from "path";
import { v4 as uuidv4 } from "uuid";

import { Request as ExpressReq, Response as ExpressRes } from 'express';
import { Request as ExpressReq, Response as ExpressRes } from "express";

const app = Express();
app.use(Express.json());

const openApiPath = path.join(__dirname, '..', '..', 'openapi.json');
const openApiPath = path.join(__dirname, "..", "..", "openapi.json");
console.log(openApiPath);

const templates: Record<string, any> = {};

// define api
const api = new OpenAPIBackend({
quick: true, // disabled validation of OpenAPI on load
definition: openApiPath,
handlers: {
listTemplates: async (c, req: Express.Request, res: Express.Response) =>
res.status(200).json([]),
createTemplate: async (c, req: Express.Request, res: Express.Response) =>
res.status(200).json({}),
getTemplate: async (c, req: Express.Request, res: Express.Response) =>
res.status(200).json({}),
replaceTemplate: async (c, req: Express.Request, res: Express.Response) =>
res.status(200).json({}),
deleteTemplate: async (c, req: Express.Request, res: Express.Response) =>
res.status(200).json({}),
validationFail: async (c, req: ExpressReq, res: ExpressRes) => res.status(400).json({ err: c.validation.errors }),
notFound: async (c, req: ExpressReq, res: ExpressRes) => res.status(404).json({ err: 'not found' }),
notImplemented: async (c, req: ExpressReq, res: ExpressRes) => {
const { status, mock } = c.api.mockResponseForOperation(c.operation.operationId);
return res.status(status).json(mock);
},
quick: true, // disabled validation of OpenAPI on load
definition: openApiPath,
handlers: {
createTemplate: async (c, req: Express.Request, res: Express.Response) => {
const { $class, name, ...otherData } = req.body;

if (!$class) {
return res
.status(400)
.json({ error: "Missing required property: $class" });
}

const id = uuidv4();

const newTemplate = { id, $class, name, ...otherData };
templates[id] = newTemplate;

return res
.status(201)
.header("Location", `/templates/${id}`)
.json({ id });
},

getTemplate: async (c, req: Express.Request, res: Express.Response) => {
const { id } = req.params;

const template = templates[id];

if (!template) {
return res.status(404).json({ error: "Template not found" });
}

res.json(template);
},

listTemplates: async (c, req: Express.Request, res: Express.Response) =>
res.status(200).json(Object.values(templates)),

deleteTemplate: async (c, req: Express.Request, res: Express.Response) => {
const { id } = req.params;

if (!templates[id]) {
return res.status(404).json({ error: "Template not found" });
}

delete templates[id];
res.status(204).send();
},

replaceTemplate: async (c, req: Express.Request, res: Express.Response) =>
res.status(200).json({}),

validationFail: async (c, req: ExpressReq, res: ExpressRes) =>
res.status(400).json({ err: c.validation.errors }),
notFound: async (c, req: ExpressReq, res: ExpressRes) =>
res.status(404).json({ err: "not found" }),
notImplemented: async (c, req: ExpressReq, res: ExpressRes) => {
const { status, mock } = c.api.mockResponseForOperation(
c.operation.operationId
);
return res.status(status).json(mock);
},
},
});

api.init();

// logging
app.use(morgan('combined'));
app.use(morgan("combined"));

// use as express middleware
app.use((req, res) => api.handleRequest(req as Request, req, res));

// start server
app.listen(9000, () => console.info('api listening at http://localhost:9000'));
app.listen(9000, () => console.info("api listening at http://localhost:9000"));