{"id":22076321,"url":"https://github.com/hussein4alaa/laravel-dark-documentation-generator","last_synced_at":"2025-07-24T13:30:48.333Z","repository":{"id":46664965,"uuid":"411993663","full_name":"hussein4alaa/Laravel-Dark-Documentation-Generator","owner":"hussein4alaa","description":"Auto Generate laravel api Documentation ","archived":false,"fork":false,"pushed_at":"2021-10-13T11:29:04.000Z","size":205,"stargazers_count":6,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"1.2","last_synced_at":"2025-05-08T09:19:31.002Z","etag":null,"topics":["api","documentation","laravel"],"latest_commit_sha":null,"homepage":"https://www.linkedin.com/in/hussein4alaa/","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/hussein4alaa.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":"contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-09-30T09:00:23.000Z","updated_at":"2024-07-26T22:51:57.000Z","dependencies_parsed_at":"2022-09-04T08:30:38.541Z","dependency_job_id":null,"html_url":"https://github.com/hussein4alaa/Laravel-Dark-Documentation-Generator","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/hussein4alaa/Laravel-Dark-Documentation-Generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hussein4alaa%2FLaravel-Dark-Documentation-Generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hussein4alaa%2FLaravel-Dark-Documentation-Generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hussein4alaa%2FLaravel-Dark-Documentation-Generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hussein4alaa%2FLaravel-Dark-Documentation-Generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hussein4alaa","download_url":"https://codeload.github.com/hussein4alaa/Laravel-Dark-Documentation-Generator/tar.gz/refs/heads/1.2","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hussein4alaa%2FLaravel-Dark-Documentation-Generator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266850080,"owners_count":23995002,"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","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","documentation","laravel"],"created_at":"2024-11-30T22:13:59.152Z","updated_at":"2025-07-24T13:30:47.866Z","avatar_url":"https://github.com/hussein4alaa.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Laravel Dark Documentation Generator 💥\n#### You can create Documentation for your api easily by using this library\n\n![me](https://github.com/hussein4alaa/Laravel-Dark-Documentation-Generator/blob/1.2/image.PNG)\n\n\n## Installation:\nRequire this package with composer using the following command:\n\n```sh\ncomposer require g4t/documentation\n```\n\n```sh\nphp artisan vendor:publish --provider=g4t\\Documentation\\DocumentationServiceProvider\n```\n\n## Default Endpoints\n##### For documentation `http://yoururl/g4t/doc` \n##### For json `http://yoururl/g4t/json` \nYou can change this endpoints from `config/documentation.php`\n```sh\n\u003c?php\nreturn [\n    'json_url' =\u003e 'g4t/json',\n    'documentation_url' =\u003e 'g4t/doc'\n];\n```\n\n\n## Usage\n##### when you create route in api.php this package will work 😉\n##### if you send data in body or query params You should add some comments before function 😔\n\n\n#### You have two ways to use it\n#### 💥 1 - by using auto database schema detect\n### Example:\n```sh\n    /**\n     * start FunctionName function\n     * title: Create Users\n     * table: users\n     * remove: [\"remember_token\", \"email_verified_at\"]\n     * replace: {\"password\": \"password\", \"email\": \"email\", \"image\": \"file\"}\n     * end FunctionName function\n     */\n```\n### Comment Explain\nComment | Description | Status\n--------- | ------- | -------\n`start FunctionName function` | you should write function Name in `FunctionName` | Required\n`title:` | This title will show in documentation , if this not found will use function name | not Required\n`table:` | to get table `users` schema |\n`remove:` | to remove columns from Docuumentation | Not Required\n`replace:` | to replace input types in Documentation | Not Required\n`end FunctionName function` | you should write function Name in `FunctionName` | Required\n\n\n### 💥 2 - manualy\n### Example:\n```sh\n    /**\n     * start FunctionName function\n     * auth\n     * title: get user by id\n     * string $name required\n     * int $number\n     * email $email required\n     * password $password\n     * file $image\n     * end FunctionName function\n     */\n```\n\n### Comment Explain\nComment | Description | Status\n--------- | ------- | -------\n`auth` | if this function need auth , if you using auth middleware on route you don't need to add this comment | not Required\n`string $name required` | name column is string and required | \n`int $number` | number column is integer and not required | \n`email $email required` | email column is string and input type in documentation is email and required | \n`password $password` | password column is string and input type in documentation is password and not required | \n`file $image` | image column is string and input type in documentation is image and not required | \n\n\n\n### License\n\nLaravel Dark Documentation Generator is free software licensed under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhussein4alaa%2Flaravel-dark-documentation-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhussein4alaa%2Flaravel-dark-documentation-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhussein4alaa%2Flaravel-dark-documentation-generator/lists"}