文档章节

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

mecisery
 mecisery
发布于 2017/09/12 10:20
字数 473
阅读 260
收藏 1
点赞 0
评论 0
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

共有 人打赏支持
mecisery
粉丝 1
博文 43
码字总数 23707
作品 0
海淀
基于 Markdown 的文档发布管理软件 - godoc

showdoc是一个基于 Markdown 的文档发布管理软件,godoc 作为 showdoc 的 go语言重构版本,对原项目做了功能上的精简。 Api文档 数据字典 安装方法

李虎头
05/19
0
0
ShowDoc v2.1.0 发布,IT 团队的在线 API 文档工具

ShowDoc v2.1.0 发布,IT 团队的在线 API 文档工具 更新内容: 支持自动生成数据字典文档:脚本自动运行,更改表结构后会同步更新文档,以后更新数据字典再也不用手动维护。详情可见:https...

xingchen
04/23
0
0
获取某一日最近的工作日[用于还款计算]

做过金融类网站的都知道,经常会遇到,还款日计算的问题.而且一般都是节假日顺延. 很多程序员都被一句话节假日顺延这个词给弄蒙了.不知道怎么下手了.所以为了这些朋友们不再烦恼我做了个api接口...

xiaogg
07/12
0
0
ipa 安装包不用市场如果扫码下载安装 免费IOS安装API

在做开发过程中可能会用于生成测试包的情况,不过测试包不能直接安装,非常不方便,所以我提供给大家一下可通过链接下载安装的方法也可以把链接生成二维码扫码下载 api地址: 文件地址:http://t...

xiaogg
07/17
0
0
API文档编写工具

从网络上检索到一些与API文档编写工具相关的资料,特记录如下: APIDoc 一个简单的RESTful API文档生成工具,主要是对代码中的注释来生成文档。开源,http://apidoc.tools prmd 根据JOSN样式...

OpenIoT
2016/07/28
379
0
推荐几个在线接口编辑工具

http://api.crap.cn/index.do 开源,Java版本,功能也不少,重要的是有Chrome插件 http://help.kancloud.cn/41497 功能强大,自己去体验 http://www.showdoc.cc 简单好用,支持加密,调试(编...

3kqing
2016/09/21
85
0
ShowDoc v1.4.3,IT 团队的在线 API 文档

更新内容: 新增开放API,可以通过API来批量更新文档 重写项目设置,让交互更友好 支持站内链接 图片可以粘贴上传 增加Docker部署方式 创建单页项目功能 复制项目功能 更新步骤请参考部署手册...

xingchen
2017/06/08
2.1K
1
ShowDoc 1.5.3 发布,IT 团队的在线 API 文档工具

更新内容: 修复编辑器在部分可触屏屏幕下的bug 修复json格式化工具会把number类型转为string的bug 编辑文档时支持直接插入html代码,并支持预览 关闭页面缓存,使修改模板、配置时能立马生效...

xingchen
2017/08/16
1K
2
ShowDoc v1.61 发布,IT 团队的在线 API 文档工具

更新内容: 1、禁用server 目录缓存,以便在不同服务器之间迁移。迁移直接复制文件夹过去即可 2、导出word文件的时候可以指定目录 3、对话框优化 更新步骤请参考部署手册:https://www.showd...

xingchen
2017/09/04
1K
0
ShowDoc v1.8.0 发布,IT 团队的在线 API 文档工具

更新内容: 1、编辑时每分钟自动保存内容到浏览器本地,以便意外情况下能恢复草稿。 2、完善登录页面UI 3、完善注册页面UI 4、完善项目密码输入页面UI 更新步骤请参考部署手册:https://www...

xingchen
2017/10/16
1K
3

没有更多内容

加载失败,请刷新页面

加载更多

下一页

SpringBoot | 第十章:Swagger2的集成和使用

前言 前一章节介绍了mybatisPlus的集成和简单使用,本章节开始接着上一章节的用户表,进行Swagger2的集成。现在都奉行前后端分离开发和微服务大行其道,分微服务及前后端分离后,前后端开发的...

oKong
今天
9
0
Python 最小二乘法 拟合 二次曲线

Python 二次拟合 随机生成数据,并且加上噪声干扰 构造需要拟合的函数形式,使用最小二乘法进行拟合 输出拟合后的参数 将拟合后的函数与原始数据绘图后进行对比 import numpy as npimport...

阿豪boy
今天
4
0
云拿 无人便利店

附近(上海市-航南路)开了家无人便利店.特意进去体验了一下.下面把自己看到的跟大家分享下. 经得现场工作人员同意后拍了几张照片.从外面看是这样.店门口的指导里强调:不要一次扫码多个人进入....

周翔
昨天
1
0
Java设计模式学习之工厂模式

在Java(或者叫做面向对象语言)的世界中,工厂模式被广泛应用于项目中,也许你并没有听说过,不过也许你已经在使用了。 简单来说,工厂模式的出现源于增加程序序的可扩展性,降低耦合度。之...

路小磊
昨天
172
1
npm profile 新功能介绍

转载地址 npm profile 新功能介绍 npm新版本新推来一个功能,npm profile,这个可以更改自己简介信息的命令,以后可以不用去登录网站来修改自己的简介了 具体的这个功能的支持大概是在6这个版...

durban
昨天
1
0
Serial2Ethernet Bi-redirection

Serial Tool Serial Tool is a utility for developing serial communications, custom protocols or device testing. You can set up bytes to send accordingly to your protocol and save......

zungyiu
昨天
1
0
python里求解物理学上的双弹簧质能系统

物理的模型如下: 在这个系统里有两个物体,它们的质量分别是m1和m2,被两个弹簧连接在一起,伸缩系统为k1和k2,左端固定。假定没有外力时,两个弹簧的长度为L1和L2。 由于两物体有重力,那么...

wangxuwei
昨天
0
0
apolloxlua 介绍

##项目介绍 apolloxlua 目前支持javascript到lua的翻译。可以在openresty和luajit里使用。这个工具分为两种模式, 一种是web模式,可以通过网页使用。另外一种是tool模式, 通常作为大规模翻...

钟元OSS
昨天
2
0
Mybatis入门

简介: 定义:Mybatis是一个支持普通SQL查询、存储过程和高级映射的持久层框架。 途径:MyBatis通过XML文件或者注解的形式配置映射,实现数据库查询。 特性:动态SQL语句。 文件结构:Mybat...

霍淇滨
昨天
2
0
开发技术瓶颈期,如何突破

前言 读书、学习的那些事情,以前我也陆续叨叨了不少,但总觉得 “学习方法” 就是一个永远在路上的话题。个人的能力、经验积累与习惯方法不尽相同,而且一篇文章甚至一本书都很难将学习方法...

_小迷糊
昨天
1
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部