liucg1995/laravel-apidoc

laravel apidoc

维护者

详细信息

gitee.com/liu-chengguo/laravel-apidoc

主页

源代码

问题

安装: 1

依赖: 0

建议者: 0

安全: 0

1.0.1 2021-08-12 13:58 UTC

Requires

  • php: ^7.0

MIT 7dfd0c4c2ae678e3035c12196d0efac8aea39bbd

  • author

laravelapidoc

This package is not auto-updated.

Last update: 2024-09-21 03:13:31 UTC

README

安装

$ composer require liucg1995/laravel-apidoc

添加服务提供者 (laravel<5)

Liucg1995\Apidoc\ApidocServiceProvider::class

配置文件

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

安装Apidoc

$ npm install apidoc -g

调试时加入Apidoc中间件

Liucg1995\Apidoc\Middleware\ApiDoc::class

生成接口请求文档

在header请求中添加三个参数

  • createDoc 创建Apidoc文档
  • apiname 接口名称
  • apidescription 接口介绍

Header-示例

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

手动生成文档

$ php artisan apidoc:generate

Apidoc文档目录

/storage/framework/apidoc