# laravel-apidoc

**Repository Path**: liu-chengguo/laravel-apidoc

## Basic Information

- **Project Name**: laravel-apidoc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-08-12
- **Last Updated**: 2021-08-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# laravel-apidoc

## 安装

```Shell
$ composer require liucg1995/laravel-apidoc
```



### 添加 service provider ( laravel<5 )

```PHP
Liucg1995\Apidoc\ApidocServiceProvider::class
```

### 配置文件

```Shell
$ php artisan vendor:publish --provider="Liucg1995\Apidoc\ApidocServiceProvider"
```

## 安装Apidoc

```Shell
$ npm install apidoc -g
```

## 调试加入Apidoc中间件

```PHP
Liucg1995\Apidoc\Middleware\ApiDoc::class
```


## 接口请求生成文档

在header请求中增加三个参数
- createDoc         创建Apidoc文档
- apiname           接口名称
- apidescription    接口介绍

Header-Example:

```json
{
    "apidescription":"apidescription",
    "apiname":"apiname",
    "createDoc":1
}
```

## 手动生成文档

```Shell
$ php artisan apidoc:generate
```

## Apidoc文档目录

```PHP
/storage/framework/apidoc
```