README

由BR Technologies制作的API-Docs是一个用于自动创建和管理Laravel应用程序API文档的包。该包可以自动记录API请求并生成详细的文档。

特性

API请求自动记录
详细的API文档
自动生成cURL命令
基于IP和API前缀过滤

安装

使用Composer安装包

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

将服务提供者添加到config/app.php文件中（Laravel 5.5+版本中会自动添加）

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

发布配置文件

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

运行迁移

php artisan migrate

配置

在config/api-docs.php文件中可以调整以下参数

ip_prefix: 注册时允许的IP前缀 api_prefix: 将要注册的API请求的前缀

您也可以在.env文件中设置这些参数

API_DOCS_IP_PREFIX=YOUR_IP_PREFIX
API_DOCS_API_PREFIX=api/*

使用

安装包后，所有配置好的IP和API前缀对应的API请求将被自动记录。要查看API文档，请

GET /api-docs

要获取特定API端点的详细信息，请

GET /api-docs/{id}

包结构

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

本README文件包含了为BR Technologies定制的API-Docs包的所有基本信息。包结构包括主要组件和使用说明。您可以根据自己的需求和包的特定特性进一步改进此文件。

br-tech / api-docs

维护者

详情

README

特性

安装

配置

使用

包结构