{"id":20494048,"url":"https://github.com/jaystack/odata-v4-server","last_synced_at":"2025-07-18T07:05:01.937Z","repository":{"id":12465663,"uuid":"67407333","full_name":"jaystack/odata-v4-server","owner":"jaystack","description":"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.","archived":false,"fork":false,"pushed_at":"2022-12-07T23:20:34.000Z","size":2454,"stargazers_count":78,"open_issues_count":45,"forks_count":55,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-07-03T06:39:03.049Z","etag":null,"topics":["nodejs","odata","typescript"],"latest_commit_sha":null,"homepage":"https://jaystack.com/products/jaystack-odata-v4-server/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jaystack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-05T09:31:05.000Z","updated_at":"2025-05-08T06:41:10.000Z","dependencies_parsed_at":"2023-01-13T16:57:50.710Z","dependency_job_id":null,"html_url":"https://github.com/jaystack/odata-v4-server","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/jaystack/odata-v4-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaystack%2Fodata-v4-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaystack%2Fodata-v4-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaystack%2Fodata-v4-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaystack%2Fodata-v4-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaystack","download_url":"https://codeload.github.com/jaystack/odata-v4-server/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaystack%2Fodata-v4-server/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265716306,"owners_count":23816354,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nodejs","odata","typescript"],"created_at":"2024-11-15T17:38:00.439Z","updated_at":"2025-07-18T07:05:01.910Z","avatar_url":"https://github.com/jaystack.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JayStack OData V4 Server\n\nOData V4 server for node.js\n\n## Features\n\n* OASIS Standard OData Version 4.0 server\n* usable as a standalone server, as an Express router, as a node.js stream or as a library\n* expose service document and service metadata - $metadata\n* setup metadata using decorators or [metadata JSON](https://github.com/jaystack/odata-v4-service-metadata)\n* supported data types are Edm primitives, complex types, navigation properties\n* support create, read, update, and delete entity sets, action imports, function imports, collection and entity bound actions and functions\n* support for full OData query language using [odata-v4-parser](https://github.com/jaystack/odata-v4-parser)\n  * filtering entities - $filter\n  * sorting - $orderby\n  * paging - $skip and $top\n  * projection of entities - $select\n  * expanding entities - $expand\n  * $count\n* support sync and async controller functions\n* support async controller functions using Promise, async/await or ES6 generator functions\n* support result streaming\n* support media entities\n\n## Controller and server functions parameter injection decorators\n\n* @odata.key\n* @odata.filter\n* @odata.query\n* @odata.context\n* @odata.body\n* @odata.result\n* @odata.stream\n\n## Example Northwind server\n\n```typescript\nexport class ProductsController extends ODataController{\n    @odata.GET\n    find(@odata.filter filter:ODataQuery){\n        if (filter) return products.filter(createFilter(filter));\n        return products;\n    }\n\n    @odata.GET\n    findOne(@odata.key key:string){\n        return products.filter(product =\u003e product._id == key)[0];\n    }\n\n    @odata.POST\n    insert(@odata.body product:any){\n        product._id = new ObjectID().toString();\n        products.push(product);\n        return product;\n    }\n\n    @odata.PATCH\n    update(@odata.key key:string, @odata.body delta:any){\n        let product = products.filter(product =\u003e product._id == key)[0];\n        for (let prop in delta){\n            product[prop] = delta[prop];\n        }\n    }\n\n    @odata.DELETE\n    remove(@odata.key key:string){\n        products.splice(products.indexOf(products.filter(product =\u003e product._id == key)[0]), 1);\n    }\n}\n\nexport class CategoriesController extends ODataController{\n    @odata.GET\n    find(@odata.filter filter:ODataQuery){\n        if (filter) return categories.filter(createFilter(filter));\n        return categories;\n    }\n\n    @odata.GET\n    findOne(@odata.key key:string){\n        return categories.filter(category =\u003e category._id == key)[0];\n    }\n\n    @odata.POST\n    insert(@odata.body category:any){\n        category._id = new ObjectID().toString();\n        categories.push(category);\n        return category;\n    }\n\n    @odata.PATCH\n    update(@odata.key key:string, @odata.body delta:any){\n        let category = categories.filter(category =\u003e category._id == key)[0];\n        for (let prop in delta){\n            category[prop] = delta[prop];\n        }\n    }\n\n    @odata.DELETE\n    remove(@odata.key key:string){\n        categories.splice(categories.indexOf(categories.filter(category =\u003e category._id == key)[0]), 1);\n    }\n}\n\n@odata.cors\n@odata.controller(ProductsController, true)\n@odata.controller(CategoriesController, true)\nexport class NorthwindODataServer extends ODataServer{}\nNorthwindODataServer.create(\"/odata\", 3000);\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaystack%2Fodata-v4-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaystack%2Fodata-v4-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaystack%2Fodata-v4-server/lists"}