推荐一款适合团队在线的API文档---ShowDoc

Apizza 是国内领先的在线 API saas 管理平台,支持在线的 API 调试,接口管理,快速生成文档,项目管理,团队协作以及分享. Apizza ([url=http://apizza.cc?f=cc]官网[/url]) 最近推出了api团队协作功能,可以添加项目成员,共同维护编辑API文档. 主要用法 1.创建项目->进入控制台->协作人员 ps:添加的协作人员的邮箱,必须系统存在该邮箱 2.添加api ps: 1,2的顺序无所谓,任何时候添加协作人员都可以. 3.添加字段描述和返回

http://docs.ngnice.com/api            文档 http://www.ngnice.com/showcase/#/home/home                    范例

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

通过beego快速创建一个Restful风格API项目及API文档自动化 本文演示如何快速(一分钟内,不写一行代码)的根据数据库及表创建一个Restful风格的API项目,及提供便于在线测试API的界面. 一.创建数据库及数据表(MySQL) #db--jeedev -- ---------------------------- -- Table structure for `app` -- ---------------------------- DROP TABLE IF EXISTS `a

今天博主有一个Xcode生成API文档的需求,遇到了一些困难点,在此和大家分享,希望能够共同进步. 今天公司和客户交接源码,但是客户提出不仅需要源码,还需要相应的技术文档,今天博主就和大家分享一下,如何使用Xcode生成你的技术文档. 生成技术文档主要有三个工具: headerdoc, doxygen 和 appledoc.其中headerdoc是苹果官方的生成工具,后两个是第三方工具.如果Xcode版本更新,则需要重新配置第三方工具,个人感觉虽然功能强大,但是配置繁琐,推荐大家使用header

Mac上的Dash是一款非常出色的API文档管理工具,是程序开发的绝佳辅助工具.我曾经期望Dash会推出Windows版本,遗憾的是,作者Kapeli没有这个打算.而当时,他推荐了Zeal这个开源工程给我. 不久前,Kapeli更新了他的博客,分享了一款Windows上的API Documentation工具 - Velocity.虽然是由他人开发,但是Kapeli非常慷慨的提供了文档数据. Velocity的最新版本是1.0.2,在使用过程中还存在着一些问题,我在刚开始用的时候,切换了一下网络

两种方案 一.Swagger 配置 web Api 接口文档美化 二.通过NodeJS 发布Swagger UI 配置api 文档 先说一下简单的 Swagger 配置 web Api  Swagger-UI本身只提供在线测试功能,要集成它还需要告诉它本项目提供的各种服务和参数信息.这里就需要一些工作量了,不过好在许多第三方库已经给我们完成了这一工作.我这里用的是Swashbuckle,使用它也比较简单,直接使用Nuget添加其程序包即可: 1.初始化包  PM> Install-Package

接口文档是前后端开发对接时很重要的一个组件.手动编写接口文档既费时,又存在文档不能随代码及时更新的问题,因此产生了像swagger这样的自动生成接口文档的框架.swagger文档一般是随项目代码生成与更新,访问地址也是基于项目地址,因此对项目数不多的团队还好.如果团队的项目很多,比如采用微服务架构的团队,动则几十甚至上百个服务项目,那就意味着前端开发人员需要记住几十甚至上百个swagger文档地址,那就很不友好了.目前貌似还没有较流行的API文档集中化管理项目(也或者是我没找到),因此花了点时间

smart-doc是一个java restful api文档生成工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法.smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释的写,smart-doc就能帮你生成一个简易明了的markdown或是一个像GitBook样式的静态html文档.下面将介绍如何在Spring Boot项目中集成smart-doc生成一个简明的api文档. 注意: smart-doc已经被