{"id":31836255,"url":"https://github.com/marianfoo/ui5-middleware-odata-recorder","last_synced_at":"2026-06-14T01:32:46.476Z","repository":{"id":318626248,"uuid":"1067890833","full_name":"marianfoo/ui5-middleware-odata-recorder","owner":"marianfoo","description":null,"archived":false,"fork":false,"pushed_at":"2025-11-12T22:23:18.000Z","size":1467,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-14T01:32:45.621Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marianfoo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-01T14:35:32.000Z","updated_at":"2025-11-12T22:23:20.000Z","dependencies_parsed_at":"2025-10-09T08:31:37.311Z","dependency_job_id":null,"html_url":"https://github.com/marianfoo/ui5-middleware-odata-recorder","commit_stats":null,"previous_names":["marianfoo/ui5-middleware-odata-recorder"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/marianfoo/ui5-middleware-odata-recorder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marianfoo%2Fui5-middleware-odata-recorder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marianfoo%2Fui5-middleware-odata-recorder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marianfoo%2Fui5-middleware-odata-recorder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marianfoo%2Fui5-middleware-odata-recorder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marianfoo","download_url":"https://codeload.github.com/marianfoo/ui5-middleware-odata-recorder/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marianfoo%2Fui5-middleware-odata-recorder/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34306772,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-13T02:00:06.617Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-10-12T01:28:37.987Z","updated_at":"2026-06-14T01:32:46.472Z","avatar_url":"https://github.com/marianfoo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ui5-middleware-odata-recorder\n\n🎬 **Record OData traffic from your UI5 app and generate FE-mockserver-compatible datasets**\n\nPerfect for offline development, testing, and creating mock data without backend dependencies.\n\n## ✨ Key Features\n\n- 🔄 **Multi-service \u0026 Multi-tenant**: Record from multiple OData services with tenant isolation\n- 📊 **Complete Data Capture**: Gets full entities by default (removes `$select` parameters)  \n- ⚡ **Smart \u0026 Fast**: Deduplication, compression handling, real-time streaming\n- 🚫 **304 Prevention**: Automatically removes caching headers to ensure fresh metadata (v0.0.7+)\n- 🔧 **Easy Control**: REST API endpoints or URL parameters to start/stop recording\n- 📦 **Ready-to-Use**: Generates files compatible with SAP FE Mockserver\n\n## 📦 Installation\n\n```bash\nnpm install --save-dev ui5-middleware-odata-recorder\n```\n\n## ⚙️ Quick Setup\n\nAdd to your `ui5.yaml`:\n\n```yaml\nserver:\n  customMiddleware:\n    - name: fiori-tools-proxy\n      afterMiddleware: compression\n      configuration:\n        backend:\n          - path: /odata\n            url: https://your-backend.com\n    \n    - name: ui5-middleware-odata-recorder\n      afterMiddleware: fiori-tools-proxy\n      configuration:\n        services:\n          - alias: mainService\n            version: v4\n            basePath: /odata/v4/main/\n            targetDir: webapp/localService/mainService/data\n```\n\n\u003e 💡 **Tip**: Disable `fiori-tools-appreload` during recording to prevent reload loops\n\n## 🚀 Quick Start\n\n### 1. Start Recording with recordingId\n\n**Using URL parameters (recommended):**\n\n```bash\n# Start UI5 server\nui5 serve\n\n# Open browser with recording enabled and recordingId\nhttp://localhost:8080/index.html?__record=1\u0026recordingId=demo\n\n# Or for multi-tenant scenarios\nhttp://localhost:8080/index.html?__record=1\u0026recordingId=100  # SAP client 100\nhttp://localhost:8080/index.html?__record=1\u0026recordingId=200  # SAP client 200\n```\n\n**Using REST API:**\n\n```bash\n# Start recording with specific recordingId\ncurl \"http://localhost:8080/__recorder/start?recordingId=demo\u0026mode=stream\"\n\n# Check recording status\ncurl \"http://localhost:8080/__recorder/status\"\n\n# Stop recording and save files\ncurl \"http://localhost:8080/__recorder/stop\"\n```\n\n### 2. What Gets Recorded\n\nFiles are created with recordingId suffix:\n\n```text\nwebapp/localService/mainService/data/\n├── Books-demo.json      ← recordingId: \"demo\"\n├── Orders-demo.json\n├── Books-100.json       ← recordingId: \"100\"  \n├── Orders-100.json\n└── metadata.xml\n```\n\n### 3. Replay with Mockserver\n\n```bash\n# Switch to mockserver configuration\nui5 serve --config ui5.mock.yaml\n\n# Open with specific dataset\nhttp://localhost:8080/index.html?recordingId=demo\n```\n\n### 4. No recordingId (Simple Mode)\n\n```bash\n# Record without recordingId suffix\nhttp://localhost:8080/index.html?__record=1\n\n# Creates clean filenames\nwebapp/localService/mainService/data/\n├── Books.json           ← No suffix\n├── Orders.json\n└── metadata.xml\n```\n\n### 5. Auto-start Configuration\n\n```yaml\nconfiguration:\n  autoStart: true\n  defaultTenant: \"demo\"  # Default recordingId if not in URL\n```\n\n## 📂 Output\n\nCreates mockserver-compatible files:\n\n```txt\nwebapp/localService/mainService/\n  metadata.xml          # Service metadata\n  data/\n    Books.json         # Entity data  \n    Orders-100.json    # With tenant suffix (if configured)\n```\n\n## 🔧 Configuration Options\n\n| Option | Default | Description |\n|--------|---------|-------------|\n| `autoStart` | `false` | Start recording when middleware loads |\n| `autoSave` | `\"stream\"` | Write mode: `\"stream\"` or `\"onStop\"` |\n| `removeSelectParams` | `true` | Remove `$select` to capture full entities |\n| `defaultTenant` | `undefined` | Tenant mode: `\"100\"` or `\"getTenantFromSAPClient\"` |\n| `controlEndpoints` | `true` | Enable `/__recorder/*` REST API |\n| `redact` | `[]` | Field names to remove from recorded data |\n\n## 📖 Full Documentation\n\nFor detailed guides, advanced features, and troubleshooting:\n\n**[📚 Getting Started Guide →](docs/GETTING_STARTED.md)**\n\nCovers installation, configuration, workflows, and troubleshooting.\n\n**[🎯 recordingId Usage Guide →](docs/RECORDINGID_GUIDE.md)**\n\nComplete guide for multi-dataset recording:\n\n- Multi-tenant SAP client recording\n- Test scenario management\n- Environment-specific datasets\n- REST API control\n- Best practices and troubleshooting\n\n## 📄 License\n\nApache-2.0 © Marian Zeis\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarianfoo%2Fui5-middleware-odata-recorder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarianfoo%2Fui5-middleware-odata-recorder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarianfoo%2Fui5-middleware-odata-recorder/lists"}