{"id":13879007,"url":"https://github.com/AlchemyCMS/alchemy-json_api","last_synced_at":"2025-07-16T15:30:32.973Z","repository":{"id":42680451,"uuid":"258506292","full_name":"AlchemyCMS/alchemy-json_api","owner":"AlchemyCMS","description":"A JSON:API compliant API for AlchemyCMS","archived":false,"fork":false,"pushed_at":"2024-11-15T12:04:47.000Z","size":499,"stargazers_count":6,"open_issues_count":2,"forks_count":6,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-11-15T12:34:57.486Z","etag":null,"topics":["alchemy","jsonapi"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AlchemyCMS.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2020-04-24T12:28:19.000Z","updated_at":"2024-11-15T12:04:51.000Z","dependencies_parsed_at":"2024-01-13T20:56:29.551Z","dependency_job_id":"2636e773-cc3c-4db1-a63e-15891e507b94","html_url":"https://github.com/AlchemyCMS/alchemy-json_api","commit_stats":null,"previous_names":[],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlchemyCMS%2Falchemy-json_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlchemyCMS%2Falchemy-json_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlchemyCMS%2Falchemy-json_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlchemyCMS%2Falchemy-json_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlchemyCMS","download_url":"https://codeload.github.com/AlchemyCMS/alchemy-json_api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226138849,"owners_count":17579496,"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":["alchemy","jsonapi"],"created_at":"2024-08-06T08:02:06.788Z","updated_at":"2025-07-16T15:30:32.964Z","avatar_url":"https://github.com/AlchemyCMS.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# Alchemy::JsonApi\n\nA JSON-API based API for AlchemyCMS\n\n## Installation\n\n### In your Alchemy Rails project\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'alchemy-json_api'\n```\n\nAnd then execute:\n\n```bash\n$ bundle\n```\n\nOr install it yourself as:\n\n```bash\n$ gem install alchemy-json_api\n```\n\n### In your JS/Frontend app\n\nRun this in your application:\n\n```\nnpm install @alchemy_cms/json_api --save\n```\n\nor with the package manager of your choice\n\n## Usage\n\n### In your Rails app\n\nMount the engine in your Alchemy Rails app like this:\n\n```rb\n# config/routes.rb\nmount Alchemy::JsonApi::Engine =\u003e \"/jsonapi/\"\n```\n\n\u003e __NOTE__ Pick any path you like. This will be the **prefix** of your API URLs\n\n### In your frontend app\n\nThis repo provides an NPM package with deserializers to help you convert the response into JS objects.\n\n```js\nimport { deserializePages } from \"@alchemy_cms/json_api\"\n\nconst response = await fetch(\"/jsonapi/pages.json\")\nconst data = await response.json()\nconst pages = deserializePages(data)\n\nconsole.log(pages[0].name) // =\u003e Homepage\n```\n\n## Key transforms\n\nIf you ever want to change how Alchemy serializes attributes you can set\n\n```rb\nAlchemy::JsonApi.key_transform = :camel_lower\n```\n\nIt defaults to `:underscore`.\n\n## Contributing\n\nContribution directions go here.\n\n## License\n\nThe gem is available as open source under the terms of the [BSD-3-Clause license](https://opensource.org/licenses/BSD-3-Clause).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAlchemyCMS%2Falchemy-json_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAlchemyCMS%2Falchemy-json_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAlchemyCMS%2Falchemy-json_api/lists"}