odata-fw
A framework for building OData services in ABAP with each entity implemented as its own class, reusable across services, so a model change no longer forces the SEGW service to be regenerated.
Building an OData service by hand in SEGW generates CRUD methods most entities never use; this framework gives every entity its own class instead, reusable across services, and keeps data changes in code separate from model changes made in customizing. A model change no longer forces the service to be regenerated. It covers the entity classes and the service wiring; anything past that, the README leaves to its own documentation site.
Facts
Where it sits
Who is behind it
In the atlas: maintains 1, contributes to 1@miggi92maintainerJan FröhlichContributes to this
In the atlas: contributes to 1@janfrlJosephine LeschikContributes to this
In the atlas: contributes to 1@josileschik13JustinContributes to this
In the atlas: contributes to 1@Juthbemarvineb03Contributes to this
In the atlas: contributes to 1@marvineb034 contributors
What it declares
Every artifact
- Type
- Package
- Origin
- Independently maintained
As a package
- Where it runs
- Inside its host
- Distributed through
- abapGit
Connections
Exposing data and operations through OData
Download
README
quoted from miggi92/odata-fw under MIT, readodata-fw
An abap odata framework.
Description
An OData ABAP Framework, that focuses on a easy and fast way to create OData Services in ABAP. Changes to the OData service are done in the code for data changes and in the customizing for model changes, no need to regenerate the service after changes.
Every entity has it own class, therefore every class can be reused in entities of other services.
It also reduces the mainly unused CRUD methods that the SEGW will create for every entity.
The purpose of this framework is to create a simple Odata service within a few minutes.
Every service that uses this framework can easy be extended.
Documentation
The documentation and how to use can be found under Documentation
Contributing
Comments and suggestions for improvements are welcome.
More details can be found at Contributing.
License
Please see our LICENSE for copyright and license information.
Download & Installation
Pull the source code with abapGit into your ABAP system. The latest abapGit build can be downloaded here.
Sponsors
History
Features 12, Changed 2, Fixes 7, Docs 7, Other 29
Notes
🚀 Enhancements
- ✨ added abap code highlighting (b1f59c8)
- ✨ added nav metadata (8e02385)
- ✨ update llm settings (250c6ff)
- Added customizing screens to git (25d8e0f)
- ✨ updated pnpm workspace (d82bd24)
- ✨ added mermaid support (b6a2a90)
- ✨ added rerendering when theme changed (634799f)
- ✨ changed sort_order (46dce5e)
- ✨ add OD Capabilities Annotations (02b4ed4)
- ✨ added unit handling (59c34d3)
- ✨ update subpackages generation (49bb631)
- ✨ generate abap doc for interfaces (e2a03fd)
🩹 Fixes
- 🐛 fixed action only running on the main repo not on the forks (a2e744f)
- 🐛 fixed missing tailwind dep (467e9ea)
- deps: Update dependency nuxt-llms to v0.2.0 (#270)
- 🐛 set edm types for dats (85ca406)
- 🐛 fixed path do content (1c80af4)
- 🐛 fixed path (972b55d)
- Fixed build (6160211)
💅 Refactors
📖 Documentation
- 📝 updated links and attention box (91f2a51)
- 📝 added descriptions (dff5de6)
- Updated footer (d900aa0)
- 📝 updated docs (10455b6)
- 📝 added all abap doc (1a2e45f)
- 📝 add docs for new annotations (ab033ba)
- 📝 extend mermaid diagram for annotations (0c3d464)
🏡 Chore
- release: V1.4.0 (90d137a)
- ⬆️ upgrade abap deps (fbe9c48)
- ⬆️ upgraded unimport (a9f6de4)
- ⬆️ upgrade actions (4578981)
- ♻️ changed warning (1054e67)
- 🔧 added transpiler config (7d687ed)
- ⬆️ upgrade deps (f0d2d7e)
- Update deps (2f1e771)
- ⬆️ upgrade deps (5c48a14)
- ⬆️ upgrade deps (a13a3af)
- ⬆️ upgrade deps (64c9c65)
- ⬆️ upgrade deps (861776f)
- Update pnpm/action-setup to v6 in release.yaml for consistency (0f49a4a)
- ⬆️ upgrade deps (58238f5)
- ⬆️ upgrade files from template (ba2cab7)
- Added mcp from template and updated server routes (b0ac917)
- ⬆️ upgrade deps (bf95606)
- ⬆️ upgrade docs deps (b4ba368)
- Group abaplint changes into one PR (920f1d6)
- Added lockfile maintenance with automerge (e7da8d6)
- config: Migrate config renovate.json (00b8b12)
- Enable vulnerability alerts in renovate.json (6dc913d)
- 🔥 removed unused applogo (8ff23c2)
- 🔧 rebuild docs when classes/interfaces are changed (due to abap doc) (6e599cb)
🎨 Styles
- 🎨 changed theme settings of mermaid (ae239c8)
❤️ Contributors
Features 5, Fixes 10, Docs 2, Other 10
Notes
🚀 Enhancements
- Update version number (188eb27)
- ✨ added nuxt ui docs template with content (96155b0)
- ✨ updated links (f951315)
- ✨ updated logo and title (ab517e8)
- ✨ added caching (2451649)
🩹 Fixes
- Wrong version number (893b571)
- 🐛 fixed links (a7781d2)
- 🐛 removed version (8f034d6)
- 🐛 changed directory (ab9da16)
- 🐛 fixed script not found (ca33a80)
- 🐛 fixed wrong links (757d295)
- 🐛 fixed false link (909defa)
- 🐛 fixed path (dae033e)
- 🐛 fixed output path (751d67e)
- 🐛 fixed path (7a1754a)
📖 Documentation
🏡 Chore
- 🔥 remove vitepress (ace8028)
- 🎉 init docus (2268923)
- 🔥 removed template button (4252fa2)
- 🙈 added ignore file (f66846b)
- 🔧 updated scripts (d05c1af)
- 🔥 remove frontmatter title (5b58761)
- ⬆️ upgrade deps (546f146)
🎨 Styles
- 🍱 uploaded new logo (422faf2)
🤖 CI
- 🔖 added auto release (3fa3f1d)
❤️ Contributors
- Miguel (@miggi92)
Others providing
Compare all 12 on the OData page →- launchpad-kpilaunchpad-kpiAn OData service and a one-method ABAP interface that put a number from an abap2UI5 app on a SAP Fiori launchpad tile.community org, abapPuts a number from an abap2UI5 app on a Fiori launchpad tilefrom ABAP
- com.sap.cds:cds-adapter-odata-v2com.sap.cds:cds-adapter-odata-v2The OData V2 protocol adapter for CAP Java, which the runtime serves natively once this beta module is on the classpath, so a V2 frontend keeps working without a change to the CDS model.sap official, capOData V2 protocol adapter built into the CAP Java runtimefrom CAP
- com.sap.cds:cds-adapter-odata-v4com.sap.cds:cds-adapter-odata-v4The OData V4 protocol adapter for CAP Java, auto-exposing every Application Service in the model at /odata/v4/<Service> without protocol code of its own, active by default in the CDS Maven Archetype.sap official, capOData V4 protocol adapter for CAP Java Application Servicesfrom CAP
- @cap-js-community/odata-v2-adapter@cap-js-community/odata-v2-adapterExposes a CAP service as OData V2 for clients that cannot move to V4.community org, capExposes a CAP service as OData V2from CAP
- @odatano/core@odatano/coreA CAP plugin that serves the Cardano blockchain as OData V4, giving enterprise-shaped access to a public chain, funded through Cardano Catalyst.independent, capCAP plugin serving the Cardano blockchain as OData V4from CAP
- @odatano/nightgate@odatano/nightgateIndexes the Midnight blockchain and submits transactions to it from CAP, exposed as OData V4, with command-line tools for schema deltas, key rotation and migration.independent, capCAP plugin indexing the Midnight blockchain, exposed as OData V4from CAP
- open-steamgateopen-steamgateAn ABAP application server you clone and run on your own machine: transpiled ABAP serving classic /IWBEP/ OData v2 to Fiori over a local database, with no SAP system attached.independent, abapLocal ABAP server serving /IWBEP/ OData v2 without an SAP systemfrom ABAP
- open-abap-odataopen-abap-odataA set of OData and Gateway shims in ABAP that serve services built the SEGW way, from a model provider and a data provider class, on Node.js and in "Steampunk".community org, abapOData and Gateway shims serving SEGW-style services on Node.jsfrom ABAP
- @root3287/cap-segw@root3287/cap-segwA CAP build tool that compiles a CDS service into the ABAP Model Provider and Data Provider classes a SAP Gateway SEGW project expects, for OData V4 by default or V2.independent, capCompiler from a CDS service to SEGW model and data provider classesfrom CAP
- @sap/cds@sap/cdsThe CAP Node.js runtime, which compiles the CDS model, serves the services declared in it, answers generic requests before any handler runs, and loads every cds-plugin.sap official, capCAP Node.js runtimefrom CAP
- OData Batch CreatorOData Batch CreatorBuilds the payload for an OData batch request from an uploaded $metadata XML file, generating sample data from the metadata rather than asking for it by hand.independent, abapBuilds OData batch request payloads from an uploaded $metadata filefrom ABAP
Details
Sources
Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.
Compatibility and provenance
abaplint
Contributors
History in the atlas
- First seen.
For your agent
- Ref
artifact:miggi92-odata-fw- JSON
- /artifacts/miggi92-odata-fw.json
- MCP
- Connecting an agent