当前位置: 首页 > 软件库 > Web应用开发 > Web框架 >

laravel-apidoc-generator

Laravel API Documentation Generator
授权协议 MIT License
开发语言 PHP
所属分类 Web应用开发、 Web框架
软件类型 开源软件
地区 不详
投 递 者 诸葛品
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

Laravel API Documentation Generator

Automatically generate your API documentation from your existing Laravel/Lumen/Dingo routes.

php artisan apidoc:generate

Installation

PHP 7.2 and Laravel/Lumen 5.7 or higher are required.

If your application does not meet these requirements, you can check out the 3.x branch for older releases.

composer require --dev mpociot/laravel-apidoc-generator

Laravel

Publish the config file by running:

php artisan vendor:publish --provider="Mpociot\ApiDoc\ApiDocGeneratorServiceProvider" --tag=apidoc-config

This will create an apidoc.php file in your config folder.

Lumen

  • When using Lumen, you will need to run composer require mpociot/laravel-apidoc-generator instead.
  • Register the service provider in your bootstrap/app.php:
$app->register(\Mpociot\ApiDoc\ApiDocGeneratorServiceProvider::class);
  • Copy the config file from vendor/mpociot/laravel-apidoc-generator/config/apidoc.php to your project as config/apidoc.php. Then add to your bootstrap/app.php:
$app->configure('apidoc');

Documentation

Check out the documentation at the Beyond Code homepage.

License

The Laravel API Documentation Generator is free software licensed under the MIT license.

  • Laravel 安装apiDoc 组件 //根目录下composer安装apidoc composer require mpociot/laravel-apidoc-generator //复制配置文件到config/目录中 php artisan vendor:publish --provider="Mpociot\ApiDoc\ApiDocGeneratorServiceProvider"

  • 1、简介&安装 Laravel API 文档 生成器 扩展包可以基于 Laravel 应用路由自动生成项目 API 文档。 我们使用Composer安装这个扩展包: $ composer require mpociot/laravel-apidoc-generator 安装完成后需要到 config/app.php 中注册服务提供者: Mpociot\ApiDoc\ApiDocGeneratorS

 相关资料
  • 生成一个REST风格的Web API文档。 支持的编程语言: C#, Go, Dart, Java, JavaScript, PHP(all DocStyle capable languages) CoffeeScript Erlang Ruby 插件: apidoc将自动包含已安装的插件。 apidoc-plugin-schema从api模式生成并注入apidoc元素。npm install a

  • Apidoc是一个通过解析注解生成 API 接口文档的 PHP composer 扩展,支持在线调试、Mock数据、Md文档等功能。   全面的注解引用、数据表字段引用,简单的注解即可生成Api文档,而Apidoc不仅于接口文档,在线接口调试、Mock调试数据、调试事件处理、Json/TypeScript生成、批量测试、接口分享、代码生成器、Api市场等诸多实用功能,致力于提高Api接口开发效率。

  • uniadmin-apidoc是无侵入的Swagger3/OpenApi3.0接口文档查看工具UI。引用即可生效,无需自己配置路由,无需自己部署swagger-ui到public目录。 插件为你做好了一切,基于ThinkPHP6的无侵入OpenApi UI界面,基于swagger-bootstrap-ui制作。 软件架构 基于ThinPHP6的ServiceProvider与Swagger-Boo

  • ThinkPHP ApiDoc 是一款基于 ThinkPHP 根据注释自动生成 API 接口文档的工具。 ��‍♀️ Apidoc是什么? 如今,前后端分离的开发模式以必不可少,基于ThinkPHP你可以很方便的作为后端Api的开发。可是一个Api开发过程中需要快速调试,开发完成后需要给其它开发者对接,这时一个详细的Api文档,就显得特别重要。 大多数开发者可能都是通过各种工具配合来达到这一目的,

  • 基于 tp6 的 api 生成模块,参考 fastadmin 的 api 模块 引用 下载到 tp6 的extend\jmwl下 use jmwl\realapidoc\Builder;use think\facade\View; 使用 这里是所有的需要生成api的控制器路径啦、所以,你可以先获取到模块下的所有控制器 Builder(["\app\admin\controller\Demo",

  • APIdoc是一个简单的 RESTful API 文档生成工具,它从代码注释中提取特定格式的内容,生成文档。 目前支持支持以下语言:C#、C/C++、Go、Java、Javascript、Perl、PHP、Python、Ruby、Rust 和 Swift。