https://github.com/axeldotdev/laravel-api-doc

This package help you build your REST API documentation.
https://github.com/axeldotdev/laravel-api-doc

api docs laravel php

Last synced: 4 months ago
JSON representation

This package help you build your REST API documentation.

• Host: GitHub
• URL: https://github.com/axeldotdev/laravel-api-doc
• Owner: axeldotdev
• License: mit
• Created: 2022-05-17T10:24:09.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-10-09T17:35:47.000Z (over 2 years ago)
• Last Synced: 2025-08-31T20:49:57.707Z (9 months ago)
• Topics: api, docs, laravel, php
• Language: PHP
• Homepage:
• Size: 293 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

          
# Laravel API Doc

[![Latest Version on Packagist](https://img.shields.io/packagist/v/axeldotdev/laravel-api-doc.svg?style=flat-square)](https://packagist.org/packages/axeldotdev/laravel-api-doc)

[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/axeldotdev/laravel-api-doc/run-tests?label=tests)](https://github.com/axeldotdev/laravel-api-doc/actions?query=workflow%3Arun-tests+branch%3Amain)

[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/axeldotdev/laravel-api-doc/Check%20&%20fix%20styling?label=code%20style)](https://github.com/axeldotdev/laravel-api-doc/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)

[![Total Downloads](https://img.shields.io/packagist/dt/axeldotdev/laravel-api-doc.svg?style=flat-square)](https://packagist.org/packages/axeldotdev/laravel-api-doc)

This package help you build your REST API documentation.

## Installation

You can install the package via composer:

```bash

composer require axeldotdev/laravel-api-doc

```

You can publish the config file with:

```bash

php artisan vendor:publish --tag="laravel-api-doc-config"

```

Optionally, you can publish the views using

```bash

php artisan vendor:publish --tag="laravel-api-doc-views"

```

## Features

- Customizable get started view

- Customizable authentication view

- Customizable errors view

- Auto-generated routes views via API routes, controllers, requests, etc.

- Customizable routes views

- Versions manager

- Copy code examples into the clipboard

Coming soon :

- Fields and params example values, enums values, etc.

- Code examples in Curl, PHP and Javascript

- Static generator into a HTML file

## Testing

```bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [Axel Charpentier](https://github.com/axeldotdev)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.