{"id":18458317,"url":"https://github.com/crazyfactory/api-package-starter","last_synced_at":"2025-07-14T02:38:05.491Z","repository":{"id":74458780,"uuid":"147155923","full_name":"crazyfactory/api-package-starter","owner":"crazyfactory","description":"starter package to write mini APIs","archived":false,"fork":false,"pushed_at":"2018-09-03T06:14:38.000Z","size":39,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-17T23:39:03.082Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","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/crazyfactory.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-09-03T05:31:28.000Z","updated_at":"2018-09-03T06:14:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"293ddb4a-b7ce-4c8c-a811-031a0a6adce5","html_url":"https://github.com/crazyfactory/api-package-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/crazyfactory/api-package-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyfactory%2Fapi-package-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyfactory%2Fapi-package-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyfactory%2Fapi-package-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyfactory%2Fapi-package-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crazyfactory","download_url":"https://codeload.github.com/crazyfactory/api-package-starter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crazyfactory%2Fapi-package-starter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260655383,"owners_count":23042793,"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-11-06T08:17:50.805Z","updated_at":"2025-07-14T02:38:05.477Z","avatar_url":"https://github.com/crazyfactory.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"### Mini Api Starter\n\nUse this project for writing any new code which will have any endpoints.\n\n### Requirements:\n\n- php \u003e 7.1\n- ext-json: *\n\n### Setup:\n```bash\ngit clone git@github.com:crazy-factory/api-package-starter.git project\ncd project\nrm .git\ngit init\ngit add .\ngit commit -m 'WIP: initial commit'\n```\n\nSimply make a initial commit.\n\n### Starting project:\n```bash\nphp -S 127.0.0.1:8000 -t public\n```\nand it should start development server.\n\n### Viewing routes:\n```bash\nphp crazy.php route:list\n```\nShould display all registered routes\n\n### Gotchas:\nsdk generation isn't done yet, but will be done soon, before this project is adapted, sdk is supposed to work.\n\n### Defining a new route:\nOpen `src/Routes.php` and add to registerRoutes method\n```php\n$routeCollection-\u003eadd(\"name\", $this-\u003eget('/path/to/route', Controller::class, 'methodName'));\n```\n\n### Creating a new controller.\n- `php crazy.php make:controller`\n- Enter name of controller, eg: UserController\n\n### Creating a new command\n- `php crazy.php make:command`\n- enter command name which will trigger that command\n- enter command description\n- register command to crazy.php\n\n### Important stuffs\ndon't just randomly return stuff from controller method, even though you CAN return response, string or a plain array,\nit'll be rejected in PR from now onwards. Any response should be a proper type. For example: UserController:list shouldn't return array,\nIt should return array of Users model, models are defined in `src/Models` directory.\n\nSimilarly if a method expects something from POST body, it should only be submitted as a JSON data, and not form data. __fromString() method should be used to create that model. Model should take care of validating entirely.\nThat should be clearly documented using @expects Params. This helps automatic generation of Sdk for later use.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrazyfactory%2Fapi-package-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrazyfactory%2Fapi-package-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrazyfactory%2Fapi-package-starter/lists"}