PHPackages                             br-tech/api-docs - 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. br-tech/api-docs

ActiveLibrary[API Development](/categories/api)

br-tech/api-docs
================

API documentation package for Laravel

115PHP

Since Sep 17Pushed 1y ago1 watchersCompare

[ Source](https://github.com/Umid-ismayilov/api-docs)[ Packagist](https://packagist.org/packages/br-tech/api-docs)[ RSS](/packages/br-tech-api-docs/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

API-Docs Package
================

[](#api-docs-package)

BR Technologies tərəfindən hazırlanmış API-Docs, Laravel tətbiqləri üçün API sənədləşdirməsini avtomatik olaraq yaratmaq və idarə etmək üçün bir paketdir. Bu paket, API sorğularınızı avtomatik olaraq qeyd edir və ətraflı sənədləşdirmə yaradır.

Xüsusiyyətlər
-------------

[](#xüsusiyyətlər)

- API sorğularının avtomatik qeydiyyatı
- Detallı API sənədləşdirməsi
- cURL komandalarının avtomatik generasiyası
- İP və API prefiksi üzərindən filtrasiya

Quraşdırma
----------

[](#quraşdırma)

1. Composer vasitəsilə paketi yükləyin:

```
composer require br-tech/api-docs:dev-main
```

2. Servis provayderini config/app.php faylına əlavə edin (Laravel 5.5+ versiyalarda avtomatik olaraq əlavə olunur):

```
'providers' => [
   Br\ApiDocsPackage\ApiDocsServiceProvider::class,
   ],
```

3. Konfiqurasiya faylını nəşr edin:

```
php artisan vendor:publish --provider="Br\ApiDocsPackage\ApiDocsServiceProvider" --tag="config"
```

4. Migrasiyaları işə salın:

```
php artisan migrate
```

Konfiqurasiya
-------------

[](#konfiqurasiya)

config/api-docs.php faylında aşağıdakı parametrləri tənzimləyə bilərsiniz:

ip\_prefix: Qeydiyyat üçün icazə verilən IP prefiksi api\_prefix: Qeydiyyat ediləcək API sorğularının prefiksi

Bu parametrləri .env faylında da təyin edə bilərsiniz:

```
API_DOCS_IP_PREFIX=YOUR_IP_PREFIX
API_DOCS_API_PREFIX=api/*
```

İstifadə
--------

[](#i̇stifadə)

Paket quraşdırıldıqdan sonra, konfiqurasiya edilmiş IP və API prefiksinə uyğun bütün API sorğuları avtomatik olaraq qeydə alınacaq. API sənədləşdirməsini görmək üçün:

```
GET /api-docs
```

Xüsusi bir API endpointi haqqında ətraflı məlumat əldə etmək üçün:

```
GET /api-docs/{id}
```

Paket Strukturu
---------------

[](#paket-strukturu)

```
api-docs/
├── src/
│   ├── ApiDocsController.php
│   ├── ApiDocsServiceProvider.php
│   ├── config/
│   │   └── api-docs.php
│   ├── database/
│   │   └── migrations/
│   │       └── 2024_01_01_000000_create_api_docs_table.php
│   └── views/
│       ├── api_docs.blade.php
│       └── api_doc_detail.blade.php
├── composer.json
├── LICENSE
└── README.md
```

Bu README faylı, BR Technologies üçün uyğunlaşdırılmış API-Docs paketinin bütün əsas məlumatlarını əhatə edir. Paket strukturu, əsas komponentlər və istifadə təlimatları daxil edilmişdir. Siz bu faylı öz ehtiyaclarınıza və paketinizin spesifik xüsusiyyətlərinə uyğun olaraq daha da təkmilləşdirə bilərsiniz.

###  Health Score

16

—

LowBetter than 5% of packages

Maintenance29

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity17

Early-stage or recently created project

 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/b4f85169e6f0aac92d2ce9d4032fe093388ca261f44519eaabe8b0d37099f75b?d=identicon)[Umid-ismayilov](/maintainers/Umid-ismayilov)

---

Top Contributors

[![Umid-ismayilov](https://avatars.githubusercontent.com/u/49947736?v=4)](https://github.com/Umid-ismayilov "Umid-ismayilov (23 commits)")

### Embed Badge

![Health badge](/badges/br-tech-api-docs/health.svg)

```
[![Health](https://phpackages.com/badges/br-tech-api-docs/health.svg)](https://phpackages.com/packages/br-tech-api-docs)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[facebook/php-business-sdk

PHP SDK for Facebook Business

90821.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

74513.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

265103.1M454](/packages/google-gax)[google/common-protos

Google API Common Protos for PHP

173103.7M50](/packages/google-common-protos)

PHPackages © 2026

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