ShowDoc

一个非常适合 IT 团队的在线 API 文档、技术文档工具

应用资料已收录 仅供查阅,暂不支持 Cockpit 直接安装

应用介绍

OVERVIEW

产品介绍

ShowDoc 是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc,你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档,你还可以利用showdoc的自动化能力,从程序注释中自动生成API文档,或者从搭配的RunApi客户端(类似postman的api调试工具)中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端,有win客户端、mac客户端、ios、android等,更方便跨平台使用。

主要功能

  • API文档:随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。
  • 数据字典:一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。
  • 说明文档:你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。

版本与部署参数

VERSIONS

以下信息来自开源应用包模板,仅用于技术参考;尚未转换成可直接使用的 Cockpit 安装配置。

配置字段

参数说明属性
PANEL_APP_PORT_HTTP端口必填

原始模板存在特定平台的网络或环境变量依赖,不能直接作为 Cockpit 安装文件使用。