使用ShowDoc在线管理API接口文档
ShowDoc是什么
每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !!
ShowDoc就是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率。
它可以用来做什么
它可以用来非常方便快速地编写出美观的API文档。
它可以用来记录数据表结构,一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。
它还可以用来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。
另外它还支持文档的分享与导出,默认使用markdown编辑以及模板插入,极大的提高工作效率。
安装
先cd进入运行web的目录,如/var/www/html/。执行以下命令:
composer create-project showdoc/showdoc
随后web目录下会出现一个showdoc文件夹。
通过浏览器访问http://xxx.com/showdoc/install (请将网址更改为你服务器域名或ip) 便可执行ShowDoc的初始化。
(请确保install 目录、server/Application/Runtime、Application/Common/Conf/config.php、Application/Home/Conf/config.php、/Application/Runtime 、 /Public/Uploads 、 /Sqlite 、 /Sqlite/showdoc.db.php 有可写权限)
如果你想安装到域名的根目录,请自行移动文件夹,或者设置apache/nginx绑定域名到showdoc目录。
安装成功之后就可以在线管理API文档了
API实例:
数据库结构实例:
更多查看文档请查看ShowDoc官网
使用ShowDoc在线管理API接口文档相关推荐
- 分享一个强大的在线写API接口文档的工具showdoc
网站地址:https://www.showdoc.cc 第一步:注册 第二步:填写注册信息,这里填写用户名和密码即可,用户名不可重复,注册登录后可以绑定邮箱. 也可以不注册查看示例决定要不要使用这个网 ...
- api服务器开发语言,【API编写】介绍一个国内强大的API接口文档写作网站showdoc - 最好的编程语言 - 博客园...
这几天要写一个接口API文档,经理给我发过来一个,说要弄一个这样的接口文档,我一看,这可麻烦呀,有大纲有详细,我以为要用div+css去一个页面一个页面做呢,这工作量可不小,网站一搜索,竟然有可以直接 ...
- 盘点 8 款好用的 API 接口文档管理工具
随着互联网的普及和发展,API 接口已经无处不在.它已经在 Web 应用程序.移动应用程序.云计算.物联网.人工智能等领域中得到广泛应用. 例如,在金融行业中,API 接口可以被用于构建支付服务.银行 ...
- echarts4离线使用文档_适合写API接口文档的管理工具有哪些?
现在越来越流行前后端分离开发,使用ajax交互.所以api接口文档就变的十分有意义了,目前市场有哪些比较优秀的接口文档管理工具呢? 1.MinDoc 网址:https://www.iminho.me/ ...
- 如何自动生成 API 接口文档 - 一份详细指南
本篇文章详细教你如何使用 Apifox 的 IDEA 插件实现自动生成接口代码.好处简单总结有以下几点: 自动生成接口文档: 不用手写,一键点击就可以自动生成文档,当有更新时,点击一下就可以自动同步接 ...
- 引入swagger2 api接口文档并实现离线文档
文章目录 前言 目的 导入工具 写一个config类 启动类添加注解 试启动页面 补充并实现文档 特殊点 再次启动页面 导出swagger在线文档为离线文档 忽略SSL证书 前言 本篇文章在于介绍sw ...
- Swagger 生成 PHP API 接口文档
Swagger 生成 PHP API 接口文档 标签(空格分隔): php 1.概况 有同学反馈写几十个接口文档需要两天的工作量, 随着多部门之间的协作越来越频繁, 维护成本越来越高, 文档的可维护性 ...
- Laravel使用swagger PHP生成api接口文档
Laravel使用swagger PHP生成api接口文档 Swagger集接口文档和测试于一体,就类比将postman和showdoc的结合体 首先要先安装基于laravel5的swagger包 地 ...
- Swagger3 API接口文档规范课程(Java1234)(内含教学视频+源代码)
Swagger3 API接口文档规范课程(Java1234)(内含教学视频+源代码) 教学视频+源代码下载链接地址:https://download.csdn.net/download/weixin_ ...
- java扫描接口_一种扫描接口并生成可调用API接口文档的方法与流程
本发明属于JavaWeb开发技术领域,涉及一种API接口文档的生成方法,尤其是一种扫描接口并生成可调用API接口文档的方法. 背景技术: API(Application Programming Int ...
最新文章
- centos 系统使用verdaccio搭建npm私库
- 读后感:你的灯亮着吗
- PHP接入支付宝手机网站支付、移动支付接口
- LightOj_1265 Island of Survival
- MySQL(12)--- 插入数据
- Python+OpenCV:Optical Flow(光流)
- Arcgis栅格时序地图制作---时间轴动态展示多期影像
- POJ 3126 Prime Path 简单广搜(BFS)
- ABP源码分析五:ABP初始化全过程
- 学习-【前端】-angularjs基本框架以及向服务器发送请求的方法
- 怎样打开VOIP与SIP
- c++学习笔记 第四部分
- 为什么c语言排在第一位,c语言我排第几个
- 斯坦福2021年度AI报告:从研发、技术、经济等多维度解读AI发展
- 12- 定时器介绍和定时器0定时1ms
- [Windows 10](Windows 10 解决开机小键盘灯不亮)
- STM32与OLED显示姓名学号
- 安卓微信浏览器无法支持input multiple的h5属性多图上传
- java虚拟机学习笔记1
- 【蓝桥杯】【啊哈!算法】冒泡排序