Download the PHP package icodestuff/ladocumenter without Composer
On this page you can find all versions of the php package icodestuff/ladocumenter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download icodestuff/ladocumenter
More information about icodestuff/ladocumenter
Files in icodestuff/ladocumenter
Package ladocumenter
Short Description Automatically generate beautiful API documentation for your Laravel API routes using annotations.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package ladocumenter
Automatically generate beautiful API documentation for your Laravel API routes using annotations.
Installation
PHP 7.4 and Laravel 7 or higher are required.
Installing
You will need LaRecipe to serve your autogenerated markdown
run
composer require --dev binarytorch/larecipe && composer require --dev icodestuff/ladocumenter
to download both LaRecipe and LaDocumenter as a dev dependency
Then
php artisan larecipe:install to install Larecipe
And lastly publish the config
php artisan vendor:publish --provider="Icodestuff\LaDocumenter\LaDocumenterServiceProvider"
Demo Video
Here is a YouTube video showcasing the LaDocumenter package
Getting Started
The only endpoints that are documented are the ones in your api.php file.
Generating Documentation
In order to compile your annotations to markdown you will need to run:
php artisan ladocumenter:generate
Grouping Endpoints
All endpoints are grouped for easy organization. Only use @Group to group endpoints in a single controller class by adding
it to the top of the controller like so:
Example
Attributes
- Name (required)
- Description (optional)
Documenting Endpoints
The @Endpoint annotation is used for a single controller method or endpoint. Note, at this time we don't support
closures or resources 😕
Example
Attributes
- Name (required)
- Description (optional)
Specifying Request Parameters
To specify a list of valid parameters your API route accepts, use the @QueryParam or @BodyParam.
Both the @BodyParam & @QueryParam annotation takes the name, type, required, description and an example.
@BodyParam Example
@QueryParam Example
Attributes
- Name (required)
- Type (required)
- IsRequired (required)
- Description (optional)
- Example (optional)
Generating Responses
To generate a response, you must use the @ResponseExample annotation. This takes in the status of the response
as well as a link to the response file like so:
Attributes
- Status (required)
- Example (required)
Be sure to add your responses to the storage directory as that is where LaDocumenter looks for them. We recommend automatically generating responses using Laravel's testing suite.
Indicating Authentication Status
LaDocumenter automatically labels an endpoint as authenticated if the route uses the middleware defined in the config/ladocumenter.php file:
If you are using a separate auth middleware, be sure to define it in the config file.
