{"id":15029121,"url":"https://github.com/catlabinteractive/charon","last_synced_at":"2025-04-09T20:32:45.371Z","repository":{"id":38375660,"uuid":"61370253","full_name":"CatLabInteractive/charon","owner":"CatLabInteractive","description":"Charon is a framework for building self documented RESTfull API's.","archived":false,"fork":false,"pushed_at":"2024-12-17T23:37:03.000Z","size":1909,"stargazers_count":2,"open_issues_count":8,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-23T22:26:17.364Z","etag":null,"topics":["api","charon","framework","php7"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CatLabInteractive.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}},"created_at":"2016-06-17T11:53:58.000Z","updated_at":"2024-12-17T23:37:10.000Z","dependencies_parsed_at":"2024-12-18T00:28:43.431Z","dependency_job_id":"fdcf65b7-8dc7-4156-b6ca-a335cd753c1f","html_url":"https://github.com/CatLabInteractive/charon","commit_stats":{"total_commits":367,"total_committers":4,"mean_commits":91.75,"dds":"0.027247956403269713","last_synced_commit":"330fda33ede979877d82fba15276677293409963"},"previous_names":[],"tags_count":69,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CatLabInteractive%2Fcharon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CatLabInteractive%2Fcharon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CatLabInteractive%2Fcharon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CatLabInteractive%2Fcharon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CatLabInteractive","download_url":"https://codeload.github.com/CatLabInteractive/charon/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248107686,"owners_count":21048980,"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":["api","charon","framework","php7"],"created_at":"2024-09-24T20:09:46.347Z","updated_at":"2025-04-09T20:32:45.350Z","avatar_url":"https://github.com/CatLabInteractive.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Charon\n[![Build Status](https://travis-ci.org/CatLabInteractive/charon.svg?branch=master)](https://travis-ci.org/CatLabInteractive/charon)\n\n*Fractal on steroids.*\n\nWhat?\n=====\nCharon is a PHP framework for building self documented RESTful API's.\n\nPlease visit [our website](https://charon.catlab.eu/) for more information.\n\nGetting started\n===============\nWhile Charon can be used with any framework, I have created a laravel\nskeleton project to get you started fast.\n\nInstallation\n------------\n`composer create-project catlabinteractive/laravel-charon api`\n\nConfiguration\n-------------\nPlease follow the instructions on \nhttps://github.com/CatLabInteractive/laravel-charon-template\n\nWhy?\n====\nWhen building a RESTful API there are a few things that keep coming back:\n * Entity to resource transformation\n * API description\n * Resource field filtering\n * Relationship and expanding these relationships\n * Filtering\n * Sorting\n * Pagination\n\nCharon tries to take some of this work away by providing a \nframework that takes care of most of these features.\n * Instead of transformers, write definitions\n * Filter and sort based on these definitions\n * Allow clients to choose fields that should be returned\n * Expand relationships in a single request\n * Handle all pagination in one single middleware\n\nDocumentation\n=============\nBy default, Charon generates Swagger 2.0 documentation. Other \ndocumentors can be implemented by implementing the interface.\n\nFrameworks\n==========\nCharon works very well with Laravel, but the library is built\nso that it can be incorporated in other frameworks.\n\nAn ORM is not required, but makes implementing certain functionality\n(like pagination and filtering) a lot easier.\n\nContext options\n===============\nFor both fields and expand parameters: add a * to repeat the field (for \nrecursive models).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatlabinteractive%2Fcharon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcatlabinteractive%2Fcharon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatlabinteractive%2Fcharon/lists"}