tp5 自动生成api文档

布满荆棘的人生 2022-05-25 01:36 272阅读 0赞

\#api-doc

### 使用方法 ###

\#\#\#\#1、安装扩展

composer require weiwei/api-doc dev-master

> 由于我没发布版本，所有暂时需带dev-master安装

\#\#\#\#2、配置参数 安装好扩展后在 application\\extra\\ 文件夹下会生成 doc.php 配置文件 在controller参数中添加对应的类

'controller' => [
            'app\\api\\controller\\Demo'
        ]

\#\#\#\#3、在相关接口类中增加注释参数 方法如下：返回参数支持数组及多维数组

<?php
    /**
     * @title 测试demo
     * @description 接口说明
     */
    class demo
    {
        /**
         * @title 测试demo接口
         * @description 接口说明
         * @author 开发者
         * @url /api/demo
         *
         * @param name:id type:int require:1 default:1 other: desc:唯一ID
         *
         * @return name:名称
         * @return mobile:手机号
         * @return list_messages:消息列表@
         * @list_messages message_id:消息ID content:消息内容
         * @return object:对象信息@!
         * @object attribute1:对象属性1 attribute2:对象属性2
         * @return array:数组值#
         * @return list_user:用户列表@
         * @list_user name:名称 mobile:手机号 list_follow:关注列表@
         * @list_follow user_id:用户id name:名称
         */
        public function index()
        {
            //接口代码
        }
    
    }

\#\#\#\#4、在浏览器访问[http://你的域名/doc][http_doc] 查看接口文档

\#\#\#\#5、预览

![Image 1][]![Image 1][]![Image 1][]

代码：https://gitee.com/lyf2017/api\_doc

[http_doc]: http://xn--6qqv7i2xdt95b/doc
[Image 1]:

发表评论取消回复

表情：

评论列表（有 0 条评论，272人围观）

还没有评论，来说两句吧...

相关阅读

相关最佳实践：Swagger 自动生成 Api 文档

目录 Tapir 介绍为什么使用 Tapir 快速使用 Tapir 添加依赖定义一个端点(Endpoint) 生成 Swagger ui 根据 yaml 生成

忘是亡心i/ 2024年03月23日 21:36/ 0 赞/ 34 阅读

相关 tp5.0自动生成模块

tp5和tp3不同，tp5的目录生成依赖build.php文件。模块生成方法如下： a、需要在入口文件Public/index.php最后加以下两句： // 读取自

超、凢脫俗/ 2023年08月17日 17:28/ 0 赞/ 78 阅读

相关 5分钟集成实现SpringBoot自动生成API接口文档（下篇）

![image-20201115233510014][] 前言这是一篇整合性质的文章，也可以认为是[5分钟集成实现SpringBoot自动生成API接口文档][5_S

偏执的太偏执、/ 2022年12月21日 10:47/ 0 赞/ 132 阅读

相关 Beego搭建api服务，自动生成文档。

在网上找了一些例子，为了应用方便，自己简单记录一下。前提条件：配置GOPATH、GOBIN、PATH 一、检查环境配置，很重要！ Ubuntu16.04下配置（~/.

古城微笑少年丶/ 2022年06月18日 05:36/ 0 赞/ 263 阅读

相关 tp5 自动生成api文档

\api-doc 使用方法 \\\\1、安装扩展 composer require weiwei/api-doc dev-master > 由于我没发布版本

布满荆棘的人生/ 2022年05月25日 01:36/ 0 赞/ 273 阅读

相关 swagger自动生成API文档

swagger自动生成API文档一、pom.xml配置  <dependency> <groupId

た入场券/ 2022年05月16日 11:44/ 0 赞/ 364 阅读

相关 CodeIgniter+swagger实现 PHP API接口文档自动生成功能自动生成ci RESTFUL api接口文档

一、安装swagger 1、首先需要有composer，没有的自行百度安装 2、下载swagger，打开网站[https://packagist.org/package

﹏ヽ暗。殇╰゛Y/ 2022年04月02日 04:37/ 0 赞/ 444 阅读

相关 SpringBoot+Swagger2实现自动生成API文档

Swagger概述 > Swagger是一组围绕OpenAPI规范构建的开源工具，可帮助设计、构建、记录和使用REST API。 > 简单说下，它的出现就是为了方便进

深碍√TFBOYSˉ_/ 2022年01月29日 12:39/ 0 赞/ 525 阅读

相关 spring boot ＋Swagger-ui 自动生成API文档

随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、先后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。这样后段开发好了api 之后就

一时失言乱红尘/ 2021年12月14日 03:23/ 0 赞/ 366 阅读

相关 shoDoc自动生成API文档使用说明

shoDoc使用说明操作系统windos,其他操作系统见官网介绍自动生成API 主要步骤： 1. 安装git for windows :[git][

冷不防/ 2021年07月26日 23:40/ 0 赞/ 608 阅读