1 Star 0 Fork 0

刘成国/laravel-apidoc

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
313123-1231231213 313123 json 7dfd0c4 4年前
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

laravel-apidoc

安装

$ composer require liucg1995/laravel-apidoc

添加 service provider ( 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-Example:

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

手动生成文档

$ php artisan apidoc:generate

Apidoc文档目录

/storage/framework/apidoc
MIT License Copyright (c) author Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

暂无描述 展开 收起
README
MIT
取消

发行版 (1)

全部
4年前

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/liu-chengguo/laravel-apidoc.git
git@gitee.com:liu-chengguo/laravel-apidoc.git
liu-chengguo
laravel-apidoc
laravel-apidoc
main

搜索帮助