V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX  ›  star7th  ›  全部回复第 55 页 / 共 55 页
回复总数  1089
1 ... 46  47  48  49  50  51  52  53  54  55  
2016-09-06 20:13:21 +08:00
回复了 star7th 创建的主题 程序员 开源的在线 API 文档、技术文档工具 ShowDoc
@tomczhen fitnesse 也不错, ShowDoc 跟它的定位不一样。 ShowDoc 更多定位于文档的编辑与阅读,不限于 api 文档。所以 api 测试功能在 ShowDoc 上会是个很轻量的附加功能
2016-09-06 15:33:58 +08:00
回复了 star7th 创建的主题 程序员 开源的任务队列服务 HTQ
@keller 当初不做周期性定时任务是因为觉得它跟 crontab 没有区别,做出来没意思。所以不做。但如果你要用也可以的。先推送一个定时任务进队列。在脚本每次执行完的时候把下一次执行的定时任务又再推进队列。
2016-09-06 14:54:17 +08:00
回复了 janesccot 创建的主题 程序员 自己搭一个 Markdown 服务写 API 有推荐的吗
2016-09-06 14:43:45 +08:00
回复了 star7th 创建的主题 程序员 开源的任务队列服务 HTQ
@wph95 不支持 long pull 呢。 HTQ 并不是用于消息队列的场景的,解决的是 http 的方式执行任务这种场景。至于容错,是有可为空间,可以完善些。鉴于当前 HTQ 刚出来,而 redis 的持久化能力其实不错了,所以还没有做到这种更细微的容错。
2016-09-06 14:39:27 +08:00
回复了 star7th 创建的主题 程序员 开源的任务队列服务 HTQ
@ecloud @breeswish 其实消息队列和任务队列的应用场景有些区别的。 HTQ 解决的是 http 的方式执行任务这种场景,它并不是为消息队列而生。更具体点的话,它还支持定时队列和可变队列,这是普通的消息队列里没有的。详细在文中的应用场景有介绍到。
2016-09-06 14:38:51 +08:00
回复了 star7th 创建的主题 程序员 开源的任务队列服务 HTQ
@cxbig 其实消息队列和任务队列的应用场景有些区别的。 HTQ 解决的是 http 的方式执行任务这种场景,它并不是为消息队列而生。更具体点的话,它还支持定时队列和可变队列,这是普通的消息队列里没有的。详细在文中的应用场景有介绍到。
2016-09-06 14:35:57 +08:00
回复了 star7th 创建的主题 程序员 开源的在线 API 文档、技术文档工具 ShowDoc
@johnzh 没怎么用过 readthedocs 。 ShowDoc 最大的优势在于开源。很多企业或者团队对数据比较敏感,开源部署到他们服务器的话他们比较放心。另外不太清楚 readthedocs 是否有团队协作功能
2016-09-06 14:34:03 +08:00
回复了 star7th 创建的主题 程序员 开源的在线 API 文档、技术文档工具 ShowDoc
@ersic “在线 API 调试和 Git 版本控制””,其实 ShowDoc 也提供了简单的在线调试以及页面历史版本功能。另外, ShowDoc 相比看云最大的优势在于开源。很多企业或者团队对数据比较敏感,开源部署到他们服务器的话他们比较放心。
2015-12-01 16:51:05 +08:00
回复了 f0101 创建的主题 程序员 求推荐一个开源的 API 文档管理系统
ShowDoc 是什么

每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?! Show me the doc !!
程序员都很希望别人能写技术文档,而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版,想着新建的 word 文档放在哪个目录等各种非技术细节。
word 文档零零散散地放在团队不同人那里,需要文档的人基本靠吼,吼一声然后上 qq 或者邮箱接收对方丢过来的文档。这种沟通方式当然可以,只是效率不高。
ShowDoc 就是一个非常适合 IT 团队的在线文档分享工具,它可以加快团队之间沟通的效率。
它可以用来做什么

API 文档( 查看 Demo )

随着移动互联网的发展, BaaS (后端即服务)越来越流行。服务端提供 API , APP 端或者网页前端便可方便调用数据。用 ShowDoc 可以非常方便快速地编写出美观的 API 文档。
数据字典( 查看 Demo )

一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。
说明文档

你完全可以使用 showdoc 来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅
它都有些什么功能

分享与导出

响应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成 word 文件,以便离线浏览。
权限管理

公开项目与私密项目
ShowDoc 上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。
项目转让
项目创建者可以自由地把项目转让给网站的其他用户。
项目成员
你可以很方便地为 ShowDoc 的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)
编辑功能

markdown 编辑
ShowDoc 采用 markdown 编辑器,无论是编辑还是阅读体验都极佳很棒。如果你不了解 Markdown ,请在搜索引擎搜索"认识与入门 Markdown"
模板插入
在 ShowDoc 的编辑页面,点击编辑器上方的按钮可方便地插入 API 接口模板和数据字典模板。插入模板后,剩下的就是改动数据了,省去了很多编辑的力气。
历史版本
ShowDoc 为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。
部署到自己的服务器

克隆或者下载代码:
https://github.com/star7th/showdoc
导入数据库
下载代码后,将跟目录的 showdoc.sql 文件导入 mysql 数据库
修改配置文件
进入 Application/Common/Conf/目录,编辑 config.php 文件,填写相应的数据库信息
目录权限
请确保 Application/Runtime 有可写权限
使用在线的 ShowDoc

如果你没有自己的服务器,但又想使用 ShowDoc 作为分档分享工具,你可以使用在线的 ShowDoc http://doc.star7th.com
版权

ShowDoc 遵循 Apache2 开源协议发布,并提供免费使用。
版权所有 Copyright © 2015 by star7th http://blog.star7th.com All rights reserved.
1 ... 46  47  48  49  50  51  52  53  54  55  
关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2527 人在线   最高记录 6679   ·     Select Language
创意工作者们的社区
World is powered by solitude
VERSION: 3.9.8.5 · 20ms · UTC 03:46 · PVG 11:46 · LAX 19:46 · JFK 22:46
Developed with CodeLauncher
♥ Do have faith in what you're doing.