PHPackages                             jheckdoc/jheckdoc-laravel - 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. jheckdoc/jheckdoc-laravel

ActiveLibrary[API Development](/categories/api)

jheckdoc/jheckdoc-laravel
=========================

Simplify creating api documentations.

v1.1.1(5y ago)522445[2 PRs](https://github.com/jericizon/jheckdoc-laravel/pulls)MITVuePHP ^7.1

Since Oct 30Pushed 5y ago1 watchersCompare

[ Source](https://github.com/jericizon/jheckdoc-laravel)[ Packagist](https://packagist.org/packages/jheckdoc/jheckdoc-laravel)[ Docs](https://github.com/jheckdoc/jheckdoc-laravel)[ RSS](/packages/jheckdoc-jheckdoc-laravel/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (2)Versions (7)Used By (0)

[![JheckDoc Laravel logo](https://github.com/jericizon/jheckdoc-laravel/raw/master/assets/logo/jheckdoc-logo.jpg)](https://github.com/jericizon/jheckdoc-laravel)

Jheckdoc laravel
----------------

[](#jheckdoc-laravel)

 [![MIT License](https://camo.githubusercontent.com/7c124530b7c185c6928998842a1a52ed4bfd21071bf67db8f325f470cc3160a3/68747470733a2f2f696d672e736869656c64732e696f2f61706d2f6c2f61746f6d69632d64657369676e2d75692e7376673f)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs) [![GitHub last commit](https://camo.githubusercontent.com/df4e78127e23dbeb20da32b58417d35a395eff55a9dd5a70737c1cd19783420d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6173742d636f6d6d69742f676f6f676c652f736b69612e7376673f7374796c653d666c6174)](#)

Simple laravel api document generator

[![Dashboard preview](https://github.com/jericizon/jheckdoc-laravel/raw/master/assets/jheckdoc-preview.jpg)](https://github.com/jericizon/jheckdoc-laravel/blob/master/assets/jheckdoc-preview.jpg)

Demo page:
----------

[](#demo-page)

Installation
------------

[](#installation)

You can install the package via composer

```
composer require jheckdoc/jheckdoc-laravel
```

Usage
-----

[](#usage)

Generate json file

```
php artisan jheckdoc:generate
```

### Publish config files

[](#publish-config-files)

```
$ php artisan vendor:publish --tag=jheckdoc-config
```

### Parameters

[](#parameters)

NameTypeDescription`@jheckdocInfo`StringTThis is required for details of api documentation. [Sample header](annotations/ApiInformation.php)`@jheckdoc`StringThis is required to add on top of each codeblocks. [Sample annotation](annotations/BasicAnnotation.php)`method`StringYour desired route method, Sample `GET`, `POST`, `PUT`, `DELETE`, `OPTIONS``route`StringYour api endpoint. Note: no need to put the full url`name`StringEnter desired name for your endpoint`description`StringDescription of your endpoint`headers`ObjectFor custom headers`params`ObjectEnter parameters for your endpoint`responses`ObjectServer responses### Api documentation detail information (required)

[](#api-documentation-detail-information-required)

```
/*@jheckdocInfo
{
    "version": "1.0.0",
    "title":"Jheckdoc API",
    "description" : "Sample description of api",
    "contact" : "hello@jheckdoc.com",
    "servers": [
        {
            "url" : "https://jheckdoc.com",
            "description": "Production api server"
        },
        {
            "url" : "https://dev.jheckdoc.com",
            "description": "Development api server"
        }
    ]
}
*/
```

### Sample annotation

[](#sample-annotation)

Each code block requires a valid json format. Please see [Sample annotations](annotations) for more.

```
/*@jheckdoc
    {
        "method" : "POST",
        "route" : "/v1/users/login",
        "name":"User login",
        "description": "Login to get authorization token.",
        "group":"user",
        "headers":{
            "Content-Type": {
                "required": true,
                "value":"application/x-www-form-urlencoded"
            }
        },
        "params" : {
            "email" :{
                "type":"string",
                "description": "Enter E-mail address",
                "required" : true
            },
            "password" :{
                "type":"string",
                "description": "Enter Password",
                "required" : true
            }
        },
        "responses": {
            "200": {
                "description": "Success"
            },
            "401": {
                "description": "Unauthenticated"
            }
        }
    }
*/
```

### View api docs (default)

[](#view-api-docs-default)

### Changelog

[](#changelog)

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

Contributing
------------

[](#contributing)

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

### Security

[](#security)

If you discover any security related issues, pelase use [issue tracker](../../issues).

Credits
-------

[](#credits)

- [Jeric Izon](https://github.com/jheckdoc)
- [All Contributors](../../contributors)

License
-------

[](#license)

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

Copyright (c) 2020, Jeric

Laravel Package Boilerplate
---------------------------

[](#laravel-package-boilerplate)

This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity24

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~12 days

Total

3

Last Release

1995d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/c7bb4a801b961bb65c544de4dc0a469518237d40f1c252a48677166a69befcb3?d=identicon)[jericizon](/maintainers/jericizon)

---

Top Contributors

[![jericizon](https://avatars.githubusercontent.com/u/8746166?v=4)](https://github.com/jericizon "jericizon (52 commits)")

---

Tags

apidocumentationjheckdoc-laravellaravelapilaraveldocumentationjheckdocjheckdoc-laravel

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/jheckdoc-jheckdoc-laravel/health.svg)

```
[![Health](https://phpackages.com/badges/jheckdoc-jheckdoc-laravel/health.svg)](https://phpackages.com/packages/jheckdoc-jheckdoc-laravel)
```

###  Alternatives

[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

2.9k34.0M112](/packages/darkaonline-l5-swagger)[knuckleswtf/scribe

Generate API documentation for humans from your Laravel codebase.✍

2.3k12.2M45](/packages/knuckleswtf-scribe)[mpociot/laravel-apidoc-generator

Generate beautiful API documentation from your Laravel application

3.5k3.1M12](/packages/mpociot-laravel-apidoc-generator)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)