showdoc(api文档工具)
showdoc会应对目前场景中API文档信息,格式编辑服务,图像快捷浏览或者是大规模的文档服务信息调整等,都去仔细安排好界面一系列数据服务端的高速优化,尤其是凸显在文档的入手转换或者是一系列内容高速同步的表现上,给予用户们必要的权限保障支持,以提高后台API接口的使用效率。
软件性能
1、编纂性能
(1)markdown编纂
ShowDoc采取markdown编纂器,不管是编纂仍是图书浏览感受都极佳很棒。若是你不领会Markdown,请在搜刮引擎搜刮”熟悉与入门 Markdown”
(2)模板拔出
在ShowDoc的编纂页面,点击编纂器上方的操控键位可便利地拔出API接口模板和数据字典模板。拔出模板后,剩下的就是改动数据了,省去了良多编纂的气力。
(3)史记版本
ShowDoc为页面供给史记版本性能,你可以便利地把页面恢复到之前的版本。
2、分享与导出呼应式网页设计,可将项目文档分享到电脑或挪动产品检查。同时也能够将项目导出成word文件,以便离线阅读。
3、权限办理
(1)公然项目与私密项目
ShowDoc上的项目有公然项目和私密项目两种。公然项目可供任何登录与非登录的用户拜候,而私密项目则需求输出密码验证拜候。密码由项目建立者设置。
(2)项目让渡
项目建立者可以自在地把项目让渡给网站的其他用户。
(3)项目成员
你可以很便利地为ShowDoc的项目加入、删除项目成员。项目成员可以对项目开启编纂,但不成让渡或删除项目(只要项目建立者才有权限)
(4)团队办理
你可以自行加入多个团队,为团队分派各种的项目,同时设置团队里每一个人的权限。
软件用处
1、API文档
跟着挪动互联网的成长,BaaS(后端即服务)愈来愈风行。服务端供给API,APP端或网页前端即可便利挪用数据。用ShowDoc可以很是便利迅速地编写出美观的API文档,同时还将拥有从代码文件中主动转换API文档
2、数据字典
一份好的数据字典可以很便利地向他人申明你的信息库布局,如各个字段的释义等。
3、申明文档
你完全可使用showdoc来编写一些东西的申明书,也能够编写一些功能标准申明文档以供团队查阅。
更新日记
Showdoc v2.4.0更新日记:
1、场景布局简练友爱
2、机能体验优化晋升
3、修复了已知bug
小编测评
showdoc平台相当具有实用性,基本端的数据库统计,API接口管理,场景数据统筹,项目信息功能性安排以及长期的内容咨询服务等,都会全放保护好必要的数据同步以及文档转换作用,另外也会有着必要的权限限制,时刻都在处置各类信息查询。
上文就是小编为您带来的showdoc(api文档工具)了,更多精彩软件请多多关注软件爱好者。