https://github.com/jaystack/odata-v4-server
With JayStack OData v4 Server you can build your own data endpoints without the hassle of implementing any protocol-level code. This framework binds OData v4 requests to your annotated controller functions, and compiles OData v4 compatible response. Clients can access services through OData-compliant HTTP requests. We recommend the JayData library for consuming OData v4 APIs.
https://github.com/jaystack/odata-v4-server
nodejs odata typescript
Last synced: 2 months ago
JSON representation
With JayStack OData v4 Server you can build your own data endpoints without the hassle of implementing any protocol-level code. This framework binds OData v4 requests to your annotated controller functions, and compiles OData v4 compatible response. Clients can access services through OData-compliant HTTP requests. We recommend the JayData library for consuming OData v4 APIs.
- Host: GitHub
- URL: https://github.com/jaystack/odata-v4-server
- Owner: jaystack
- Created: 2016-09-05T09:31:05.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T23:20:34.000Z (over 2 years ago)
- Last Synced: 2025-03-30T22:11:07.273Z (2 months ago)
- Topics: nodejs, odata, typescript
- Language: TypeScript
- Homepage: https://jaystack.com/products/jaystack-odata-v4-server/
- Size: 2.34 MB
- Stars: 77
- Watchers: 17
- Forks: 56
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JayStack OData V4 Server
OData V4 server for node.js
## Features
* OASIS Standard OData Version 4.0 server
* usable as a standalone server, as an Express router, as a node.js stream or as a library
* expose service document and service metadata - $metadata
* setup metadata using decorators or [metadata JSON](https://github.com/jaystack/odata-v4-service-metadata)
* supported data types are Edm primitives, complex types, navigation properties
* support create, read, update, and delete entity sets, action imports, function imports, collection and entity bound actions and functions
* support for full OData query language using [odata-v4-parser](https://github.com/jaystack/odata-v4-parser)
* filtering entities - $filter
* sorting - $orderby
* paging - $skip and $top
* projection of entities - $select
* expanding entities - $expand
* $count
* support sync and async controller functions
* support async controller functions using Promise, async/await or ES6 generator functions
* support result streaming
* support media entities
## Controller and server functions parameter injection decorators
* @odata.key
* @odata.filter
* @odata.query
* @odata.context
* @odata.body
* @odata.result
* @odata.stream
## Example Northwind server
```typescript
export class ProductsController extends ODataController{
@odata.GET
find(@odata.filter filter:ODataQuery){
if (filter) return products.filter(createFilter(filter));
return products;
}
@odata.GET
findOne(@odata.key key:string){
return products.filter(product => product._id == key)[0];
}
@odata.POST
insert(@odata.body product:any){
product._id = new ObjectID().toString();
products.push(product);
return product;
}
@odata.PATCH
update(@odata.key key:string, @odata.body delta:any){
let product = products.filter(product => product._id == key)[0];
for (let prop in delta){
product[prop] = delta[prop];
}
}
@odata.DELETE
remove(@odata.key key:string){
products.splice(products.indexOf(products.filter(product => product._id == key)[0]), 1);
}
}
export class CategoriesController extends ODataController{
@odata.GET
find(@odata.filter filter:ODataQuery){
if (filter) return categories.filter(createFilter(filter));
return categories;
}
@odata.GET
findOne(@odata.key key:string){
return categories.filter(category => category._id == key)[0];
}
@odata.POST
insert(@odata.body category:any){
category._id = new ObjectID().toString();
categories.push(category);
return category;
}
@odata.PATCH
update(@odata.key key:string, @odata.body delta:any){
let category = categories.filter(category => category._id == key)[0];
for (let prop in delta){
category[prop] = delta[prop];
}
}
@odata.DELETE
remove(@odata.key key:string){
categories.splice(categories.indexOf(categories.filter(category => category._id == key)[0]), 1);
}
}
@odata.cors
@odata.controller(ProductsController, true)
@odata.controller(CategoriesController, true)
export class NorthwindODataServer extends ODataServer{}
NorthwindODataServer.create("/odata", 3000);
```