tp5 自动生成api文档

#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 查看接口文档

####5、预览

代码：https://gitee.com/lyf2017/api_doc

tp5 自动生成api文档相关推荐

springboot 集成 swagger 自动生成API文档
Swagger是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的Web服务.简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言的前后端分离解决方案. S ...
【接口文档】Django restful framework中自动生成API文档
Django restful framework中自动生成API文档一.Swagger概述 1.引言当接口开发完成,紧接着需要编写接口文档.传统的接口文档使用Word编写,or一些接口文档管理平台 ...
swagger php修改成中文,PHP使用swagger自动生成API文档
使用 swagger 自动生成 API 文档使用 swagger 自动生成 API 文档,有需要的朋友可以参考下. 一.下载 swagger-ui 直接上传服务器二.下载 swagger-php ...
SpringBoot 自动生成API文档
SpringBoot 自动生成API文档在做项目的时候,如果项目是前后分离的,后端一定要和前端或者是移动端对接接口,那么问题来了,接口是不是要自己写给他们看,一般的会采用Excel或者Word来写, ...
超详细！使用swagger自动生成Api文档（swagger-ui）
介绍 swagger是什么? swagger-ui 使用swagger-ui 简单使用 swagger api注解本文参考: 介绍这里是一些介绍,如果想直接看如何使用,请直接跳过这部分.但如果有时 ...
windows api中文文档_Web服务开发：Spring集成Swagger，3步自动生成API文档
目录: 1,Spring Boot集成Swagger 2,Swagger接口文档页面 3,常见问题和解决方法在Sping开发REST接口服务时,API文档是不可缺少的一个重要部分.Swagger框架 ...
swagger 修改dto注解_Web服务开发：Spring集成Swagger，3步自动生成API文档
目录: 1,Spring Boot集成Swagger 2,Swagger接口文档页面 3,常见问题和解决方法在Sping开发REST接口服务时,API文档是不可缺少的一个重要部分.Swagger框架 ...
PHP使用swagger-php自动生成api文档（详细附上完整例子）
thinkphp5结合swagger自动生成接口文档整体介绍 swagger-php.swagger-ui.swagger-editor swagger-ui:主要就是放到tp项目public目录下 ...
如何利用showdoc自动生成API文档
介绍 showdoc是一个适合IT团队的文档工具,阅读本文前需要对showdoc有基本了解 .基本介绍可看:https://www.showdoc.cc/help 对于写API文档这件事,虽然说文本编 ...

tp5 自动生成api文档

使用方法

tp5 自动生成api文档相关推荐

最新文章

热门文章