Skip to content

hdlovefork/api-doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

laravel-api-doc

在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后缀文件,并以商城->商品模块的层级结构显示在左侧列表中。

License

Licensed under The MIT License (MIT).

About

在Laravel中快速使用Markdown格式生成api文档

Resources

Stars

Watchers

Forks

Packages

No packages published