https://github.com/hussein4alaa/laravel-dark-documentation-generator
Auto Generate laravel api Documentation
https://github.com/hussein4alaa/laravel-dark-documentation-generator
api documentation laravel
Last synced: 11 months ago
JSON representation
Auto Generate laravel api Documentation
- Host: GitHub
- URL: https://github.com/hussein4alaa/laravel-dark-documentation-generator
- Owner: hussein4alaa
- License: mit
- Created: 2021-09-30T09:00:23.000Z (over 4 years ago)
- Default Branch: 1.2
- Last Pushed: 2021-10-13T11:29:04.000Z (over 4 years ago)
- Last Synced: 2025-05-08T09:19:31.002Z (about 1 year ago)
- Topics: api, documentation, laravel
- Language: PHP
- Homepage: https://www.linkedin.com/in/hussein4alaa/
- Size: 200 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Dark Documentation Generator 💥
#### You can create Documentation for your api easily by using this library
## Installation:
Require this package with composer using the following command:
```sh
composer require g4t/documentation
```
```sh
php artisan vendor:publish --provider=g4t\Documentation\DocumentationServiceProvider
```
## Default Endpoints
##### For documentation `http://yoururl/g4t/doc`
##### For json `http://yoururl/g4t/json`
You can change this endpoints from `config/documentation.php`
```sh
'g4t/json',
'documentation_url' => 'g4t/doc'
];
```
## Usage
##### when you create route in api.php this package will work 😉
##### if you send data in body or query params You should add some comments before function 😔
#### You have two ways to use it
#### 💥 1 - by using auto database schema detect
### Example:
```sh
/**
* start FunctionName function
* title: Create Users
* table: users
* remove: ["remember_token", "email_verified_at"]
* replace: {"password": "password", "email": "email", "image": "file"}
* end FunctionName function
*/
```
### Comment Explain
Comment | Description | Status
--------- | ------- | -------
`start FunctionName function` | you should write function Name in `FunctionName` | Required
`title:` | This title will show in documentation , if this not found will use function name | not Required
`table:` | to get table `users` schema |
`remove:` | to remove columns from Docuumentation | Not Required
`replace:` | to replace input types in Documentation | Not Required
`end FunctionName function` | you should write function Name in `FunctionName` | Required
### 💥 2 - manualy
### Example:
```sh
/**
* start FunctionName function
* auth
* title: get user by id
* string $name required
* int $number
* email $email required
* password $password
* file $image
* end FunctionName function
*/
```
### Comment Explain
Comment | Description | Status
--------- | ------- | -------
`auth` | if this function need auth , if you using auth middleware on route you don't need to add this comment | not Required
`string $name required` | name column is string and required |
`int $number` | number column is integer and not required |
`email $email required` | email column is string and input type in documentation is email and required |
`password $password` | password column is string and input type in documentation is password and not required |
`file $image` | image column is string and input type in documentation is image and not required |
### License
Laravel Dark Documentation Generator is free software licensed under the MIT license.