PHPackages                             baodhtv01/api-doc-packages - 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. baodhtv01/api-doc-packages

ActiveLibrary[API Development](/categories/api)

baodhtv01/api-doc-packages
==========================

A beautiful RESTful API documentation package for Laravel using Scalar UI.

v1.0.1(1mo ago)06MITPHPPHP ^8.0 || ^8.1 || ^8.2 || ^8.3 || ^8.4

Since May 4Pushed 1mo agoCompare

[ Source](https://github.com/baodhtv01/api-doc-packages)[ Packagist](https://packagist.org/packages/baodhtv01/api-doc-packages)[ RSS](/packages/baodhtv01-api-doc-packages/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependencies (2)Versions (2)Used By (0)

Laravel API Documentation (Scalar UI)
=====================================

[](#laravel-api-documentation-scalar-ui)

Một thư viện Laravel mạnh mẽ, tự động hóa và tuyệt đẹp để tạo tài liệu RESTful API (sử dụng [Scalar UI](https://github.com/scalar/scalar)).

Package được thiết kế với tiêu chí **Plug and Play** - Cài đặt là chạy, không cần viết cấu hình hay sinh file JSON thủ công!

Các tính năng nổi bật
---------------------

[](#các-tính-năng-nổi-bật)

- 🚀 **Tự động quét API**: Tự động nhận diện toàn bộ các route bắt đầu bằng `api/` trong Laravel.
- 🗂️ **Tự động nhóm (Auto Grouping)**: Tự động gom nhóm các API dựa trên URL segment (ví dụ: `api/users` và `api/users/{id}` sẽ nằm trong nhóm **Users**).
- 🎨 **Giao diện hiện đại**: Giao diện Scalar UI sang trọng, vượt trội so với Swagger truyền thống.
- 🌙 **Dark/Light Mode**: Hỗ trợ giao diện sáng tối tự động.
- ⚡ **Test Client tích hợp**: Gửi request trực tiếp ngay trên giao diện tài liệu.

Yêu cầu hệ thống
----------------

[](#yêu-cầu-hệ-thống)

- PHP ^8.0
- Laravel 9.x, 10.x, 11.x, 12.x, 13.x

Cài đặt
-------

[](#cài-đặt)

Cài đặt package thông qua Composer bằng lệnh sau:

```
composer require baodhtv01/api-doc-packages
```

Hướng dẫn sử dụng
-----------------

[](#hướng-dẫn-sử-dụng)

Ngay sau khi cài đặt, package sẽ tự động hoạt động mà không cần thêm bất kỳ thao tác nào.

1. **Khởi động server Laravel của bạn**: ```
    php artisan serve
    ```
2. **Truy cập tài liệu**: Mở trình duyệt và truy cập vào đường dẫn: 👉 ****

Tất cả các API route của bạn sẽ được tự động trích xuất, phân tích tham số (URL parameters) và hiển thị một cách gọn gàng!

Tuỳ chỉnh (Configuration)
-------------------------

[](#tuỳ-chỉnh-configuration)

Nếu bạn muốn thay đổi đường dẫn truy cập (ví dụ từ `/api-docs` sang `/docs`), hoặc muốn cấu hình nâng cao cho giao diện, bạn có thể xuất file cấu hình ra bằng lệnh:

```
php artisan vendor:publish --tag=apidoc-config
```

File `config/apidoc.php` sẽ được tạo. Tại đây, bạn có thể chỉnh sửa:

- `route`: Thay đổi URL truy cập tài liệu.
- `ui.theme`: Đổi màu sắc giao diện (hỗ trợ các theme như `moon`, `purple`, `solarized`,...).
- `ui.layout`: Đổi bố cục giao diện (classic hoặc modern).

License
-------

[](#license)

Gói thư viện này là phần mềm mã nguồn mở được cấp phép theo giấy phép [MIT license](https://opensource.org/licenses/MIT).

###  Health Score

41

—

FairBetter than 87% of packages

Maintenance93

Actively maintained with recent releases

Popularity6

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity51

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

Unknown

Total

1

Last Release

36d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/0e8d547ebd1524143ddef00f6eefded495ceb87983867167d98f02c349d11a1f?d=identicon)[baodhtv01](/maintainers/baodhtv01)

---

Top Contributors

[![baodhtv01](https://avatars.githubusercontent.com/u/59009275?v=4)](https://github.com/baodhtv01 "baodhtv01 (8 commits)")

### Embed Badge

![Health badge](/badges/baodhtv01-api-doc-packages/health.svg)

```
[![Health](https://phpackages.com/badges/baodhtv01-api-doc-packages/health.svg)](https://phpackages.com/packages/baodhtv01-api-doc-packages)
```

###  Alternatives

[psalm/plugin-laravel

Psalm plugin for Laravel

3325.1M337](/packages/psalm-plugin-laravel)[laravel/mcp

Rapidly build MCP servers for your Laravel applications.

76318.2M110](/packages/laravel-mcp)[laravel/surveyor

Static analysis tool for Laravel applications.

8390.3k12](/packages/laravel-surveyor)[api-platform/laravel

API Platform support for Laravel

59156.3k10](/packages/api-platform-laravel)

PHPackages © 2026

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