文档章节

介绍一个国内强大的API接口文档写作网站showdoc

mecisery
 mecisery
发布于 2017/09/12 10:20
字数 473
阅读 403
收藏 1
PHP

这几天要写一个接口API文档,经理给我发过来一个,说要弄一个这样的接口文档,我一看,这可麻烦呀,有大纲有详细,我以为要用div+css去一个页面一个页面做呢,这工作量可不小,网站一搜索,竟然有可以直接生成api接口文档的网站,我又孤陋寡闻了,通过这几天的使用比较,我选定了showodc。 

SHOWDOC

我本来用的apiary.io,全体也不错,而且是oralce收购的,发展应该可以,但是国外的服务器国内访问实在。。。。后来说在国内找一下,很幸运我发现了showdoc。

 

showdoc网站打开看着不起眼,但里面的内容相当的强大,重点说下特点

1:支持markdown语法(所有的api接口写作现在都支持这个吧,因为他现在太方便了)

2:支持多用户协作,你可以在项目下面随意添加多个用户一起完成api文档的写作。

3:可以分享并导出项目,生成需要的文档格式如doc,可以离线浏览

4:支持响应式,手机电脑同样精彩

5:支持项目转让

6:支持模版插入

7:支持历史版本,你可以把操作恢复到以前的版本。

8:showdoc完全开源

9:可以部署到自己的服务器

10:如果在线使用,可以设置自己的个性域名,也可以对文档进行加密,浏览者需要密码才能访问

11:可以通过一个在线测试api的工具,直接生成markdown,你几乎不用写代码就能过所有的参数自动生成

看一些页面:

 

如果你正在找快点试试吧

www.showdoc.cc

本文转载自:http://www.cnblogs.com/bestcode/p/6519746.html

共有 人打赏支持
下一篇: mysql主从设置
mecisery
粉丝 2
博文 46
码字总数 25542
作品 0
海淀
私信 提问
开发文档开源管理系统ShowDoc

ShowDoc是一款开发文档开源管理系统,国人开发,遵循Apache2 开源协议。 功能: API文档 随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调...

marsdream
07/25
0
0
ShowDoc v2.2.0 发布,IT 团队的在线 API 文档工具

ShowDoc v2.2.0 发布,IT 团队的在线 API 文档工具。 更新内容: 开源版 showdoc 新增管理后功能,可以从管理后台新增、删除用户,以及对全部项目进行集中管理等。 默认管理员账户密码是 sh...

xingchen
07/25
0
0
ShowDoc v2.3.3 发布,IT 团队的在线 API 文档工具

ShowDoc v2.3.3 已发布,这是一个 IT 团队的在线 API 文档工具。 更新内容: 为了应对复杂项目内容的分类需求,showdoc在原来目录支持的基础上增加一层子目录,支持到了三级目录。用户在新建...

xingchen
10/26
0
0
ShowDoc v2.3.0 发布,可通过程序自动生成API文档

ShowDoc v2.3.0 发布了,更新内容: 1、可以通过代码注释自动生成API文档,详情看文档https://www.showdoc.cc/page/741656402509783 2、优化json格式化功能 3、fix管理后台的控制台报错 4、登...

xingchen
08/19
0
0
ShowDoc 更新:新增一键自动安装/升级脚本

前言 自动脚本脚本利用docker来安装运行环境,适用于linux服务器。如果你的服务器没有docker服务,脚本会尝试安装之。如果你已经安装过docker,脚本会省略部分步骤,从而加快showdoc安装进度...

xingchen
09/01
0
0

没有更多内容

加载失败,请刷新页面

加载更多

day150-2018-11-17-英语流利阅读-待学习

歪果仁也疯狂:海外版抖音的征途 毛西 2018-11-17 1.今日导读 海外版抖音 TikTok 于 2017 年 5 月上线海外,至今覆盖全球 150 多个国家和地区,月活跃用户数已突破 5 亿。然而,“出海”的抖...

飞鱼说编程
今天
4
0
分布式学习最佳实践:从分布式系统的特征开始(附思维导图)

什么是分布式系统 回到顶部   分布式系统是由一组通过网络进行通信、为了完成共同的任务而协调工作的计算机节点组成的系统。分布式系统的出现是为了用廉价的、普通的机器完成单个计算机无法...

dragon_tech
今天
4
0
TOKEN设计

TOKEN设计 Api_Token 首先需要知道API是什么? API(Application Programming Interface)即应用程序接口。你可以认为 API 是一个软件组件或是一个 Web 服务与外界进行的交互的接口。而我们在...

DrChenXX
今天
3
0
浅谈“李氏代换”——从纪念金庸和斯坦李说起

李氏代换(LSP)简介 李氏代换是软件设计的一个原则,又名依赖倒转原则或依赖倒置原则,其衍生原则有接口分离原则等。该原则由Barbara Liskov于1988年提出。 该原则指出,程序中高级别的元素...

SamYjy
今天
33
0
JavaScript实现在线websocket WSS测试工具 -toolfk程序员工具网

本文要推荐的[ToolFk]是一款程序员经常使用的线上免费测试工具箱,ToolFk 特色是专注于程序员日常的开发工具,不用安装任何软件,只要把内容贴上按一个执行按钮,就能获取到想要的内容结果。T...

toolfk
今天
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部