{"id":18211964,"url":"https://github.com/jobinsjp/api-generator","last_synced_at":"2025-10-28T04:02:55.717Z","repository":{"id":51401774,"uuid":"351711167","full_name":"JoBinsJP/api-generator","owner":"JoBinsJP","description":"Generate api docs while writing test case (Laravel).","archived":false,"fork":false,"pushed_at":"2023-05-07T15:22:03.000Z","size":61,"stargazers_count":7,"open_issues_count":7,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-17T11:50:29.207Z","etag":null,"topics":["documentation","laravel","openapi","phpunit","swagger","swagger-ui","testing"],"latest_commit_sha":null,"homepage":"","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/JoBinsJP.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}},"created_at":"2021-03-26T08:23:58.000Z","updated_at":"2023-09-08T14:48:43.000Z","dependencies_parsed_at":"2024-11-21T08:45:29.815Z","dependency_job_id":"a3c6d0f6-f99c-41e0-81f6-df4b44cea34d","html_url":"https://github.com/JoBinsJP/api-generator","commit_stats":{"total_commits":18,"total_committers":4,"mean_commits":4.5,"dds":"0.33333333333333337","last_synced_commit":"3bb7df45a0b063eaac70e7bf5adf7144b633f2a3"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoBinsJP%2Fapi-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoBinsJP%2Fapi-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoBinsJP%2Fapi-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoBinsJP%2Fapi-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JoBinsJP","download_url":"https://codeload.github.com/JoBinsJP/api-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246869994,"owners_count":20847225,"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":["documentation","laravel","openapi","phpunit","swagger","swagger-ui","testing"],"created_at":"2024-11-03T15:04:11.042Z","updated_at":"2025-10-28T04:02:55.598Z","avatar_url":"https://github.com/JoBinsJP.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# API Generator\n\nGenerate api docs while writing test case (Laravel). \n\n### Idea\nIt generates api docs with [OpenAPI Specification](https://swagger.io/specification) while wiring test case in \nlaravel application. The generated docs can preview on swagger ui either integrate laravel-swagger-ui on application \nor [Swagger Editor online](https://editor.swagger.io/).\n\n##### Features\n* All basic setup features as available in swagger api.\n* Request body will define using Laravel FormRequest class.\n* The Request body example will grab from test data that used on testing.\n* Route parameters will define from Laravel route.\n* Response example grabs from the test responses.\n\n\n### Installation\n\n```shell\ncomposer require jobins/api-generator --dev\n```\n\n### Publish  assets\n\n```shell\nphp artisan vendor:publish --provider=\"Jobins\\APIGenerator\\APIGeneratorServiceProvider\"\n```\n\n### Basic Uses\n\n```php\n\u003c?php\n\nnamespace Tests\\Feature;\n\nuse App\\Http\\Requests\\RegistrationRequest;\nuse JoBins\\APIGenerator\\Security\\Bearer;\nuse JoBins\\APIGenerator\\Traits\\HasDocsGenerator;\n\nclass RegistrationTest extends TestCase\n{\n    use HasDocsGenerator;\n    \n    /** @test */\n    public function it_register_a_new_user()\n    {\n        $responseSchema = [\n            \"description\" =\u003e \"A User Object\",\n            \"define\"      =\u003e [\n                \"data.*\"  =\u003e [\"refSchema\" =\u003e \"UserSchema\"],\n                \"message\" =\u003e \"Message for user\",\n            ],\n        ];\n        \n        $this-\u003esetSummary(\"Register a new user.\")\n            -\u003esetId(\"Register\")\n            -\u003esetSecurity([Bearer::class])\n            -\u003esetTags([\"Posts\"])\n            -\u003esetRulesFromFormRequest(RegistrationRequest::class)\n            -\u003edefineResponseSchema($responseSchema)\n            -\u003ejsond(\"post\", route(\"registration.store\"), $data)\n            -\u003eassertStatus(422)\n            -\u003eassertJsonFragment([])\n            -\u003eassertJsonStructure([\"message\"])\n            -\u003egenerate($this, true);    \n    }\n}\n```\n\n### Define parameters in descriptions method of FormRequest class.\n\n```php\n\n/**\n * Class ExampleFormRequest\n * @package JoBins\\APIGenerator\\Tests\\Stubs\n */\nclass ExampleFormRequest extends FormRequest\n{\n    public function rules()\n    {\n        return [\n            \"email\"     =\u003e \"required\", // Required, String, \n            \"nickname\"  =\u003e \"sometimes|required\", // Optional Field, String\n        ];\n    }\n\n    public function descriptions()\n    {\n        return [\n            \"email\"     =\u003e \"Email of a new user.\",\n            \"nickname\"  =\u003e \"Nick name of a new user.\"\n        ];\n    }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjobinsjp%2Fapi-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjobinsjp%2Fapi-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjobinsjp%2Fapi-generator/lists"}