PHPackages                             plugins-world/laravel-doc - 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. [Utility & Helpers](/categories/utility)
4. /
5. plugins-world/laravel-doc

ActiveLibrary[Utility & Helpers](/categories/utility)

plugins-world/laravel-doc
=========================

A laravel global config package.

029PHP

Since May 12Pushed 1y ago1 watchersCompare

[ Source](https://github.com/plugins-world/LaravelDoc)[ Packagist](https://packagist.org/packages/plugins-world/laravel-doc)[ RSS](/packages/plugins-world-laravel-doc/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

laravel-doc
===========

[](#laravel-doc)

用于生成 swagger 2.0 文档的扩展包。可根据配置自动同步 yapi 文档。可开启 apifox 文档定时同步功能

[![Sponsor me](https://github.com/plugins-world/plugins-world/raw/master/sponsor-me-button-s.svg?raw=true)](https://github.com/sponsors/mouyong)

安装
--

[](#安装)

```
$ composer require plugins-world/laravel-doc -vvv
```

使用
--

[](#使用)

### 1. 配置文件修改

[](#1-配置文件修改)

```
// yapi.php
base_url 是 yapi 的 url.
project_id 是 yapi 的项目 id
token 是项目的 token

openapi 可以配置与 openapi 的路由信息。以及是否生成 openapi 文档。

openapi 文档的访问路由，默认是 /openapi
```

### 2. 单元测试与文档生成

[](#2-单元测试与文档生成)

文档生成目录：`storage/app/yapi/`

使用示例：

`routes/tenant.php`

```
// 定义路由，实际开发时替换为正式的 method、uri、controller、action
Route::any('/api/oem-info', [\Plugins\LaravelDoc\Http\Controllers\OpenapiController::class, 'example']);
Route::get('/api/patients', [\Plugins\LaravelDoc\Http\Controllers\OpenapiController::class, 'example']);
Route::post('/api/patients', [\Plugins\LaravelDoc\Http\Controllers\OpenapiController::class, 'example']);

```

`tests/TestCase.php`

```