PHPackages harlekoy/apidocs - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. harlekoy/apidocs ActiveLibrary[API Development](/categories/api) harlekoy/apidocs ================ Replacement for Swagger. It is built for Laravel v0.8.0(6y ago)263.9k2[26 issues](https://github.com/harlekoy/laravel-apidocs/issues)[26 PRs](https://github.com/harlekoy/laravel-apidocs/pulls)MITPHP Since Nov 12Pushed 3y ago2 watchersCompare [ Source](https://github.com/harlekoy/laravel-apidocs)[ Packagist](https://packagist.org/packages/harlekoy/apidocs)[ Docs](https://github.com/harlekoy/apidocs)[ RSS](/packages/harlekoy-apidocs/feed)WikiDiscussions master Synced today READMEChangelogDependencies (7)Versions (45)Used By (0) API Docs ======== [](#api-docs) [![Latest Version on Packagist](https://camo.githubusercontent.com/3c9e1a7941e4b01f74f71448c29c04b3e23f07541ac010bd348e451a2509ab44/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6861726c656b6f792f617069646f63732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/harlekoy/apidocs)[![Total Downloads](https://camo.githubusercontent.com/56826ca5b83d1f433ea7a268c5848cad7552b0ca8c73c80c5c1d14005018845f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6861726c656b6f792f617069646f63732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/harlekoy/apidocs)[![Build Status](https://camo.githubusercontent.com/bbae3410ace18d9f9e7d538ecd2c6bc34fe1b77bfdc771483840ee9408c8a142/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f6861726c656b6f792f617069646f63732f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/harlekoy/apidocs)[![StyleCI](https://camo.githubusercontent.com/cb13a877afd1dbe223c631789c3f922d3ace958fdb334a9cce9b26afefbc2ebd/68747470733a2f2f7374796c6563692e696f2f7265706f732f31323334353637382f736869656c64)](https://styleci.io/repos/12345678) This is where your description should go. Take a look at [contributing.md](contributing.md) to see a to do list. [![](https://user-images.githubusercontent.com/10015302/49337278-10868980-f64c-11e8-9bfe-29dc1c582911.png)](https://user-images.githubusercontent.com/10015302/49337278-10868980-f64c-11e8-9bfe-29dc1c582911.png) Requirements ------------ [](#requirements) - Laravel 5.5 and above Installation ------------ [](#installation) Via Composer ``` $ composer require harlekoy/apidocs ``` After installing API Docs, publish its assets, and migration file using the `apidocs:install` Artisan command. ``` $ php artisan apidocs:install ``` Updating API Docs ----------------- [](#updating-api-docs) When updating, you should re-publish API Docs's assets: ``` $ php artisan apidocs:publish ``` Reread API routes ----------------- [](#reread-api-routes) When updating your API docs route list, you should run this command to get your latest Laravel `route:list`: ``` $ php artisan apidocs:routes ``` Usage ----- [](#usage) Access your API documentation in you browser ``` /apidocs/list ``` > If you don't have any local server running in your machine, run this command first in you command line tool `php artisan serve` then it generate this `http://127.0.0.1:8000`. Now you can access the path with that hostname `http://127.0.0.1:8000/apidocs/list` enjoy using it 😄. Change log ---------- [](#change-log) Please see the [changelog](changelog.md) for more information on what has changed recently. Testing ------- [](#testing) ``` $ composer test ``` Contributing ------------ [](#contributing) Please see [contributing.md](contributing.md) for details and a todolist. Security -------- [](#security) If you discover any security related issues, please email instead of using the issue tracker. Credits ------- [](#credits) - [Harlequin Doyon](https://github.com/harlekoy) - [All Contributors](../../contributors%5D) Road map -------- [](#road-map) Laravel API Docs is still under development, I decided to ship it in this early stage so you can help me make it better. however, you can use it in production. Lets finish the task below so we can have a version 1 up and running with the right features needed. Here's the plan for what's coming: - Add support for API Docs custom path - Add transition effect for groups and endpoints accordion - Add a way to edit API Docs groups and endpoints in its the web interface - Add tests. - Add validation for required parameters License ------- [](#license) license. Please see the [license file](license.md) for more information. ### Health Score 29 ↓ LowBetter than 60% of packages Maintenance0 Infrequent updates — may be unmaintained Popularity27 Limited adoption so far Community11 Small or concentrated contributor base Maturity64 Established project with proven stability Bus Factor1 Top contributor holds 97.2% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~17 days Recently: every ~65 days Total 18 Last Release 2441d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/08833ccd041a111b44f011096f3b507bfa52207bf4f1e98799a460d66c1504fc?d=identicon)[harlekoy](/maintainers/harlekoy) --- Top Contributors [![harlekoy](https://avatars.githubusercontent.com/u/10015302?v=4)](https://github.com/harlekoy "harlekoy (35 commits)")[![taliptako](https://avatars.githubusercontent.com/u/2073785?v=4)](https://github.com/taliptako "taliptako (1 commits)") --- Tags laravelapi-docs ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/harlekoy-apidocs/health.svg) ``` [![Health](https://phpackages.com/badges/harlekoy-apidocs/health.svg)](https://phpackages.com/packages/harlekoy-apidocs) ``` ### Alternatives [darkaonline/l5-swagger OpenApi or Swagger integration to Laravel 2.9k34.0M112](/packages/darkaonline-l5-swagger)[surface/laravel-webfinger A Laravel package to create an ActivityPub webfinger. 113.8k](/packages/surface-laravel-webfinger) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)