Home
>
sap文档管理
>
软件文档管理规范
软件文档管理规范

time:2020-08-01 11:16:06

author:重庆佰鼎科技有限公司

【Font size: big medium smail

本文由重庆佰鼎科技有限公司提供,重点介绍了软件文档管理规范相关内容。重庆佰鼎科技有限公司专业提供sap文档管理,dwg文档管理,超市管理系统文档等多项产品服务。公司产品内容市场占有率逐年提升,深受赞扬,虏获了一大批忠实客户。

软件文档管理规范想写出好看的API接口文档,一些实用的工具能够对我们有很多的帮助,这里我找了一些比较实用的工具,推荐给大家。

1、Swagger

Swagger 是一套围绕OpeanAPI规范构建的开源工具,便于构建和使用REST API。Swagger UI - 让OpenAPI规范以交互式API文档呈现,是一个简单的Restful API 测试和文档工具。通过读取JSON 配置显示API. 项目本身仅仅也只依赖一些 html,css.js静态文件. 几乎可以放在任何Web容器上使用。Swagger可以完整地定义一个接口的内容,包括各个参数、返回值的具体结构、类型,Swagger Editor可以实时进行编辑并在线调试。编辑好的API可以导出为json文件,使用Swagger UI打开即可以看到更美观的接口文档。

2、Spring REST Docs

Spring REST Docs可帮助您记录RESTful服务。它结合了使用Asciidoctor编写的手写文档和使用Spring MVC Test生成的自动生成的片段。这种方法使您免受Swagger等工具生成的文档的限制。它可以帮助您生成准确,简洁和结构良好的文档。然后,该文档允许您的用户轻松获取所需信息。

3、APIDOC软件文档管理规范

APIDOC可以根据代码注释生成WEB API文档,支持大部分主流开发语言,Java、javascript、php、erlang、perl、python、ruby等等。web接口的注释维护起来更加方便,不需要额外再维护一份文档。

RESTful Web API文档生成器。

4、小幺鸡

小幺鸡支持websocket、json,xml,txt,jsonp等测试,支持form-data,x-www-form-urlencoded ,raw,binary 上传格式支持rest地址,http://www.test.com/test/{id}.json 这样的地址会自动替换id。

5、RAP

RAP是阿里的一套完整的可视化接口管理工具,可以定义接口结构,动态生成模拟数据,校验真实接口正确性。RAP围绕接口定义,提供了一系列包括团队管理、项目管理、文档版本管理、mock插件等服务。

相关推荐:

想写个 App 练手,有什么有趣的 API 接口推荐吗?

有哪些好玩的免费的API接口?软件文档管理规范

哪些网站的 API 很好用?为什么?

我是 BinSTD,国内领先的 Token 化数据 API 交易平台。

Reprint please indicate:http://www.cnsoftweb.com/wdgl-3519.html