curl http://localhost:3000/v1/projectsexample using express-openapi-validator with custom operation resolver
By default, when you configure operationHandlers to be the base path to your operation handler files, we use operationId, x-eov-operation-id and x-eov-operation-handler to determine what request handler should be used during routing.
If you ever want FULL control over how that resolution happens (e.g. you want to use your own extended attributes or simply rely on operationId), then here's how you can accomplish that following an example where our operationId becomes a template that follows {module}.{function}.
- First, specifiy the
operationHandlersoption to be an object with abasePathandresolverproperties.basePathis the path to where all your handler files are located.resolveris a function that MUST return an ExpressRequestHandlergivenbasePathandroute(which gives you access to the OpenAPI schema for a specific Operation)
new OpenApiValidator({
apiSpec,
operationHandlers: {
basePath: path.join(__dirname, 'routes'),
resolver: (basePath, route) => {
// Pluck controller and function names from operationId
const [controllerName, functionName] = route.schema['operationId'].split('.')
// Get path to module and attempt to require it
const modulePath = path.join(basePath, controllerName);
const handler = require(modulePath)
// Simplistic error checking to make sure the function actually exists
// on the handler module
if (handler[functionName] === undefined) {
throw new Error(
`Could not find a [${functionName}] function in ${modulePath} when trying to route [${route.method} ${route.expressRoute}].`
)
}
// Finally return our function
return handler[functionName]
}
});- Next, use
operationIdto specify the id of operation handler to invoke.
/projects:
get:
# This means our resolver will look for a file named "projects.js" at our
# configured base path and will return an export named "list" from
# that module as the Express RequestHandler.
operationId: project.list- Finally, create the express handler module e.g.
routes/projects.js
module.exports = {
// the express handler implementation for the projects collection
list: (req, res) => res.json(/* ... */),
};On model change, to get update we need to use several commands :
npx prisma generate
npx prisma db push
restart the application : npm run dev
https://www.prisma.io/docs/reference/api-reference/error-reference
mongosh --host zooprocess.imev-mer.fr --username root --password example
use ZooProcess
db.Project.find()
db.Project.find({"name":"monproject2"})
db.Project.find({"id":"6565b055ae8de1c051ae0ed0"})
http://zooprocess.imev-mer.fr:8081/spec
docker build -t zooprocess-back .
docker run -p 8081:8081 --name zooprocess-back zooprocess-back
show databases;
use zooProcess;
show collections;
show the collection ZoooscanCalibration
db.ZoooscanCalibration.find().limit(5).pretty()
db.Instrument.find().limit(1).pretty()
for example to update broken table due to change model I broken ZoooscanCalibration collection, when i added the frame type and link with the intrument collection
then I added the new fields: the frame type and the link with the intrument collection in each ZooscanCalibration rows
db.ZooscanCalibration.updateMany(
{},
{ $set: { frame: "LARGE", instrumentId: ObjectId("65c4e0994653afb2f69b11ce") } }
)
npx prisma studiomongosh -u root -p exampleuse admin
db.changeUserPassword("root", "your_new_password")
remplace with docker1234 your password
then update your .env file with the new password DATABASE_URL="mongodb://root:your_new_password@localhost/zooProcess?authSource=admin"
To create a new MongoDB database for this project:
Start MongoDB shell:
mongoshCreate and switch to your new database:
use zooprocess_db
Update your DATABASE_URL in .env file:
DATABASE_URL="mongodb://admin:your_new_password@localhost:27017/zooProcess?authSource=root"
Run Prisma migration to create the collections:
npx prisma db pushThe database is now ready to use with all the models defined in your schema.prisma file.
docker-compose up -d --build
Update your DATABASE_URL in .env file:
DATABASE_URL="mongodb://admin:your_new_password@localhost:27017/zooProcess?authSource=root"
db.User.insertOne({ "name": "admin", "email": "admin@invalid.com", "password": "docker1234", "role": "ADMIN" })
const bcrypt = require('bcrypt');
const hashedPassword = bcrypt.hashSync('docker1234', 10);
console.log(hashedPassword);