20.14 Node-odata + mongo

Warning

Unfinished and discontinued.

ODATA is an open protocol that allows the creation and consumption of queryable and interoperable Web service APIs in a standard way.

In this article I’ll show an example.

ODATA has multiple node packages, because it’s just a protocol, there will be different implementations.

ODATA is a bit like mongoose, being able to filter the date very precisely, whilst also becoming a CRUD app.

In this article I’ll take a look at different packages and see what suits us the best.

There is even a package to convert mongo-like queries into the odata txt format.

I do have a requirement where It has to be odata + Mongodb/mongoose.

profider/simple-odata-server

This is the npm page. It is not being maintained tho, so I’ll first look for a good alternative before doing research into this one. It is newer than most packages:

⚠️ This repository isn’t being maintained. It’s stable and still used in jsreport, but we are too busy to provide adequate maintenance. Don’t hesitate to let me know if you plan to maintain a fork so I can share it here..

npm i simple-odata-server
npm install simple-odata-server-mongodb

adamspe/odata-resource

Hasn’t been updated for 4 years, it has forks tho.

janhommes/o.js

This package is also known as odata on npm, meaning that it’s probably the first package for odata.

This is a client package.

npm i odata

zackyang000/node-odata

I am going to be using this package. here is the documentation for that package.

this ODATA package does not work together with express, it’s a separate api.

It is also not updated in 2 years, and it doesn’t seem to work for me. This combo makes me not want to use this one.

npm install node-odata

full schema

This is an example, with all the methods that are optional.

const odata = require('node-odata');
 
// Connect to MongoDB and create an OData server
const server = odata('mongodb://localhost/my-app');
 
// Define and register a resource
server.resource('books', {
  author: String,
  title: String,
  genre: String,
  price: Number,
  publish_date: Date,
  description: String,
  id: String
});
 
// Implement authorization and other configurations
server.resource('books')
  .get()
  .auth((req) => {
    // Implement your GET request authorization logic here
    // Return true if authorized, false otherwise
    return true;
  })
  .before((entity) => {
    // Perform actions before GET request
  })
  .after((entity) => {
    // Perform actions after GET request
  })
  .list()
  .auth((req) => {
    // Implement your list request authorization logic here
    return true;
  })
  .before(() => {
    // Perform actions before listing
  })
  .after((data) => {
    // Perform actions after listing
  })
  .post()
  .auth((req) => {
    // Implement your POST request authorization logic here
    return true;
  })
  .before((entity) => {
    // Perform actions before POST request
  })
  .after((originEntity, newEntity) => {
    // Perform actions after POST request
  })
  .put()
  .auth((req) => {
    // Implement your PUT request authorization logic here
    return true;
  })
  .before((entity) => {
    // Perform actions before PUT request
  })
  .after((entity) => {
    // Perform actions after PUT request
  })
  .delete()
  .auth((req) => {
    // Implement your DELETE request authorization logic here
    return true;
  })
  .before((entity) => {
    // Perform actions before DELETE request
  })
  .after((entity) => {
    // Perform actions after DELETE request
  });
 
// Listen on port 3000
server.listen(3000, () => {
  console.log('OData service running on port 3000');
});