Apidoc-php

API 接口文档生成工具
授权协议 MIT
开发语言 PHP
所属分类 开发工具、 程序文档工具
软件类型 开源软件
地区 国产
投 递 者 鲜于俊侠
操作系统 跨平台
开源组织
适用人群 未知
 软件概览
Apidoc是一个通过解析注解生成 API 接口文档的 PHP composer 扩展,支持在线调试、Mock数据、Md文档等功能。
 

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

特性

  • 开箱即用:无繁杂的配置、安装后按文档编写注释即可自动生成API文档。
  • 轻松编写:支持通用注释引用、业务逻辑层、数据表字段的引用,几句注释即可完成。
  • 在线调试:在线文档可直接调试,并支持全局请求/Mock参数/事件处理,接口调试省时省力。
  • 安全高效:支持访问密码验证、应用/版本独立密码;支持文档缓存。
  • 多应用/多版本:可适应各种单应用、多应用、多版本的项目的Api管理。
  • 分组/Tag:可对控制器/接口进行多级分组或定义Tag。
  • Markdown文档:支持.md文件的文档展示。
  • Json/TypeScript生成:文档自动生成接口的Json及TypeScript。
  • 代码生成器:配置+模板即可快速生成代码及数据表的创建,大大提高工作效率。

兼容

以下框架已内置兼容,可开箱即用。其它框架可参考其它框架安装说明进行手动兼容。

框架 版本 说明
ThinkPHP 5.1、6.x  
Laravel 8.x、9.x 其它版本未测试
Hyperf 2.x 其它版本未测试
Webman 2.x 需手动配置兼容
  • 1、安装node  http://nodejs.cn/download/ 2、修改node默认镜像 npm config list查看配置项 npm config set registry "http://registry.npm.taobao.org" 3、全局安装apidoc npm install apidoc -g 4、新建文件夹demo 5、创建apidoc.json文件和test.ph

  • 1。首先在composer.json中添加类库laravel-apidoc-generator "require": { "mpociot/laravel-apidoc-generator": "^2.1" }, 2。在命令行中执行命令 composer update 3。在bootstrap中进行注册 //api文档自动生成 $app->register(Mpociot\

  • Apidoc 使用说明 使用apidocJs快速生成在线文档 apidoc是一个轻量级的在线REST接口文档生成系统,支持多种主流语言,包括Java、C、C#、PHP和JavaScript等。使用者仅需要按照要求书写相关注释,就可以生成可读性好、界面美观的在线接口文档。 介绍apidoc的基本概念 安装、使用和简单配置 一些特殊参数的含义及其使用 介绍一些使用经验 一、前言 apidoc能做什么

  • 在使用apidoc之前,我一直使用wiki来写文档,后来发现这种方式更新起来比较痛苦,时间一长甚至就忘记了更新了。一直在寻找能够使用注释直接生成文档的程序。某一天同事推荐了apidoc,发现这正是我想要的工具。 apidoc原理 apidoc的原理是扫描你的代码文件,提取出注释部分,根据一些规则生成相应的文档。默认的模板久很美观,十分适合作为api文档的生成器。目前apidoc支持的注释基本涵盖了

 相关资料
  • CabalPHP 支持接口文档自动生成。 编写好相关配置和文档注释后浏览器访问 http://127.0.0.1:9501/__docs 即可查看相关文档,注意检查自己的监听端口和IP。 点击这里访问示例文档 接口文档地址只能在debug环境(cabal.debug配置为true)下访问。 配置 文档相关配置在 conf/cabal.php // ... 'document' =

  • 我谷歌了一下,但是所有关于昂首阔步留档的例子都使用了类。我想包括接口,因为读者感兴趣的是API而不是实现。 这是我的密码: 包括所需的maven依赖项: 我的SpringBoot应用程序: 我的RestController接口 和实施 这一切都由所需的昂首阔步配置支持: 该代码可作为maven项目在https://github.com/MKhotele/spring-examples/tree/m

  • 1. 标题栏 NT_UI.setHeader(name, style); 列表 可选值 背景色 颜色 悬浮色 大小 间距 圆角 标题栏 wrapper true 标题栏-客服头像 kefuLogo true true true 标题栏-客服名称 kefuName true 标题栏-客服个性签名 kefuSignature true 标题栏-最小化按钮 min true true 标题栏-关闭按钮

  • 初始化 xn('init') 停止默认初始化 xn('stopAutoInit'); 设置访客信息 // customerinfo的可选健值见下表 xn('setCustomerInfo', JSONObject customerinfo); 参数名称 类型 备注 默认值 uid String 用户id 无 uname String 用户名称 无 userlevel String 用户等级

  • 本文向大家介绍使用apidoc管理RESTful风格Flask项目接口文档方法,包括了使用apidoc管理RESTful风格Flask项目接口文档方法的使用技巧和注意事项,需要的朋友参考一下 使用apidoc管理RESTful风格Flask项目接口文档方法 apidoc项目地址 flask扩展包地址 文档示例地址 1.安装nodejs 2.安装apidoc 3.Flask扩展包安装 4.添加扩展包

  • 本文向大家介绍SpringBoot整合Swagger3生成接口文档过程解析,包括了SpringBoot整合Swagger3生成接口文档过程解析的使用技巧和注意事项,需要的朋友参考一下   前后端分离的项目,接口文档的存在十分重要。与手动编写接口文档不同,swagger是一个自动生成接口文档的工具,在需求不断变更的环境下,手动编写文档的效率实在太低。与新版的swagger3相比swagger2配置更

  • 为方便 Cocos Creator 开发者调试和接入腾讯云游戏多媒体引擎产品 API,本文为通过 Cocos Service 服务面板,接入腾讯云 GME 的接口文档。 此文档对应 GME SDK 的版本为 2.5.2。 函数原型为 GME Cocos SDK 接口文档 中定义的接口,Cocos Service 接入时设置了一个全局变量 tencentGME.tencentGMEInst,可参考示

  • ethers.js 主要包含以下4个模块 : 钱包(Wallet) ,Providers ,合约 Contract 以及 工具包 utils 。 在使用接口之前,请先确保正确 引入 ethers.js , 以下是接口列表: 钱包类 Wallet 和 签名器 Signer Wallet 签名器(Signer) 接口 提供者 Provider 连接以太坊网络 属性 获取网络 获取账号信息 获取以太坊状