文档章节

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

mecisery
 mecisery
发布于 2017/09/12 10:20
字数 473
阅读 439
收藏 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
粉丝 3
博文 46
码字总数 25542
作品 0
海淀
私信 提问
开发文档开源管理系统ShowDoc

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

marsdream
2018/07/25
0
0
docker+showdoc搭建

1 安装docker软件 设置环境变量 path 2 从国内安装showdoc镜像 1)docker pull registry.docker-cn.com/star7th/showdoc 备用国外镜像服务器 docker pull star7th/showdoc 2) 创建目录 权限设...

mircle
2018/09/17
0
0
ShowDoc v2.2.0 发布,IT 团队的在线 API 文档工具

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

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

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

xingchen
2018/10/26
1K
3
ShowDoc v2.0 发布,IT 团队的在线 API 文档工具

ShowDoc v2.0 发布了。ShowDoc 是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率。 更新内容: 使用vue + element框架重构了ShowDoc的前端页面,优化UI风格 提高不同页...

xingchen
2018/02/26
4.5K
5

没有更多内容

加载失败,请刷新页面

加载更多

Nextjs+React非页面组件SSR渲染

@随风溜达的向日葵 Nextjs Nextjs是React生态中非常受欢迎的SSR(server side render——服务端渲染)框架,只需要几个步骤就可以搭建一个支持SSR的工程(_Nextjs_的快速搭建见Next.js入门)...

随风溜达的向日葵
54分钟前
0
0
如何在 Linux 系统查询机器最近重启时间

在你的 Linux 或类 UNIX 系统中,你是如何查询系统上次重新启动的日期和时间?怎样显示系统关机的日期和时间? last 命令不仅可以按照时间从近到远的顺序列出该会话的特定用户、终端和主机名...

来来来来来
今天
3
0
Redis协议是什么样的

前言 我们用过很多redis的客户端,有没有相过自己撸一个redis客户端? 其实很简单,基于socket,监听6379端口,解析数据就可以了。 redis协议 解析数据的过程主要依赖于redis的协议了。 我们...

春哥大魔王的博客
今天
6
0
乱入Linux界的我是如何学习的

欢迎来到建哥学Linux,咳!咳!咳!开个玩笑哈,我是一个IT男,IT界的入门选手,正在学习Linux。 在之前,一直想进军IT界,学习IT技术,但是苦于没有人指导,也不知道学什么,最开始我自己在...

linuxCool
今天
4
0
携程Apollo统一配置中心的搭建和使用(java)

一.Apollo配置中心介绍 1、What is Apollo 1.1 Apollo简介 Apollo(阿波罗)是携程框架部门研发的开源配置管理中心,能够集中化管理应用不同环境、不同集群的配置,配置修改后能够实时推送到...

morpheusWB
今天
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部