dean/laravel-api-doc

此包的最新版本(v1.0)没有提供许可证信息。

安装: 289

依赖者: 0

建议者: 0

安全性: 0

星标: 4

关注者: 1

分支: 1

开放问题: 0

语言:HTML

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

This package is auto-updated.

Last update: 2024-09-04 18:27:01 UTC


README

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

示例

安装

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

开始

http://your-domain.com/doc

注:当APP_ENV环境变量设为localdev时才能访问该路由

配置

storage/doc/config.json

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

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

许可证

MIT许可证(MIT)下授权。