dean/laravel-api-doc

There is no license information available for the latest version (v1.0) of this package.

v1.0 2019-06-04 06:32 UTC

Requires

• erusev/parsedown: ^1.7
• laravel/framework: ^5.5

Unknown License

README

在Laravel中使用Markdown语法轻松编写API文档

安装

composer require dean/api-doc
php artisan vendor:publish --tag=dean-apidoc

开始

http://your-domain.com/doc

注：当APP_ENV环境变量设为local，dev时才能访问该路由

配置

storage/doc/config.json

[
  {
    "path": "shop",
    "name": "商城",
    "children": [
      {
        "path": "product",
        "name": "商品模块"
      }
    ]
  },
 ...
]

它将会搜索/storage/doc/shop/product目录下的所有.md后缀文件，并以商城->商品模块的层级结构显示在左侧列表中。

License

Licensed under The MIT License (MIT).