{"id":15367214,"url":"https://github.com/arfedulov/koa-jsonapi-controllers","last_synced_at":"2025-03-17T18:44:58.290Z","repository":{"id":57098679,"uuid":"220603962","full_name":"arfedulov/koa-jsonapi-controllers","owner":"arfedulov","description":"jsonapi controllers for koa","archived":false,"fork":false,"pushed_at":"2019-11-09T10:51:47.000Z","size":81,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-24T08:41:29.685Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arfedulov.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":"2019-11-09T06:54:35.000Z","updated_at":"2024-03-11T18:41:30.000Z","dependencies_parsed_at":"2022-08-20T17:31:19.179Z","dependency_job_id":null,"html_url":"https://github.com/arfedulov/koa-jsonapi-controllers","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arfedulov%2Fkoa-jsonapi-controllers","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arfedulov%2Fkoa-jsonapi-controllers/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arfedulov%2Fkoa-jsonapi-controllers/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arfedulov%2Fkoa-jsonapi-controllers/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arfedulov","download_url":"https://codeload.github.com/arfedulov/koa-jsonapi-controllers/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244091795,"owners_count":20396672,"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":[],"created_at":"2024-10-01T13:23:35.955Z","updated_at":"2025-03-17T18:44:58.263Z","avatar_url":"https://github.com/arfedulov.png","language":"TypeScript","readme":"# koa-jsonapi-controllers\n\njsonapi controllers for koa.\n\n## Installation\n\n```\nyarn add @arfedulov/koa-jsonapi-controllers\n```\n\n## Usage\n\n```ts\nimport Koa, { Context } from 'koa';\n// jsonapi error-handling middleware\nimport { jsonApiErrors } from '@arfedulov/koa-jsonapi-errors';\n\nimport {\n  BaseController,\n  createMainRequestHandler,\n  JsonapiContext,\n} from '@arfedulov/koa-jsonapi-controllers';\n\nconst app = new Koa();\n\n// Each your controller should extend BaseController\nclass UserController extends BaseController {\n  // jsonapi resource type\n  name = 'users';\n\n  // overwrite any method you want\n  // the default implementation throws NotFound error\n  getSingleResource = async (ctx: JsonapiContext) =\u003e {\n    //\n  }\n}\n\nclass PostController extends BaseController {\n  name = 'posts';\n\n  getSingleResource = async (ctx: JsonapiContext) =\u003e {\n    //\n  }\n}\n\nconst userController = new UserController();\nconst postController = new PostController();\n\nconst requestHandler = createMainRequestHandler([ userController, postController ]);\n\napp.use(jsonApiErrors);\napp.use(requestHandler);\n```\n\nAs this module throws errors, it is recommended to use it with *@arfedulov/koa-jsonapi-errors*\nmiddleware. In this case you'll get automatically generated valid jsonapi error responses.\n\n```ts\napp.use(jsonApiErrors);\napp.use(requestHandler);\n```\n\nLook at `BaseController` source code for the rest of possible request handlers.\n\nYou will probably need an access to jsonapi url parameters and url-queries.\nThose are exposed on `ctx` argument passed to each request handler. *@arfedulov/json-api-url-parser*\nmodule is used for parsing url into `ctx.[JSON_API_URL_PARAMS_KEY]`. Look the docs for [json-api-url-parser](https://github.com/arfedulov/json-api-url-parser#readme) for the list of available parameters.\n\n```ts\nimport {\n  BaseController,\n  createMainRequestHandler,\n  JsonapiContext,\n  JSON_API_URL_PARAMS_KEY,\n} from '@arfedulov/koa-jsonapi-controllers';\n\nclass PostController extends BaseController {\n  name = 'posts';\n\n  getSingleResource = async (ctx: JsonapiContext) =\u003e {\n    const jsonapiParams = ctx[JSON_API_URL_PARAMS_KEY];\n    // ......\n  }\n}\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farfedulov%2Fkoa-jsonapi-controllers","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farfedulov%2Fkoa-jsonapi-controllers","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farfedulov%2Fkoa-jsonapi-controllers/lists"}