米兰足球体育网站 - 专业的足球赛事资讯与数据服务平台

广州总部电话:020-8556431118026208884
21年
互联网应用服务商
广州总部电话:020-8556431118026208884
21年
互联网应用服务商
请输入搜索关键词
知识库 知识库

米兰体育知识库

探索行业前沿,共享知识宝库

企业应该要有一个独立的文档系统

发布日期:2026-11-05 14:27:33 浏览次数: 912 来源:芊芊爸爸
推荐语
专为软件企业打造的全功能开源文档系统,规避商用工具数据泄露风险,牢牢守住核心信息资产。
核心内容:
1. 商用第三方文档工具的潜在数据安全隐患,自研整合型文档系统的开发背景
2. 该全栈文档系统的技术栈、各类核心功能与实际使用效果介绍
3. 项目开源地址分享,企业自主掌控核心信息资产的核心思路
小优 网站建设顾问
专业来源于二十一年的积累,用心让我们做到更好!
受前面笔记项目的启发,公司现在API文档+数据库文档+设计文档+升级文档,都是apifox+showdoc组合使用,showdoc还好是开源的内部部署,但是apifox就是使用的商业软件。
这里就有个问题,我们现在是完全信任商业软件提供方,但是谁又能堤防的了它们商业软件的研发和运维人员不外露数据?
懂的都懂,说白了、人怕出名猪怕壮,这些东西就不能给它们卡脖子的机会、让其有可能对我们的资料为所欲为。
假如哪天,它们的运维偷偷的把资料“卖给”我们的竞争方,这还怎么竞争?
so 基于此背景,就让AI开发了一个“API(TCP/MQTT/gRPC等含各种协议的测试)文档+数据库文档+设计文档+升级文档”集所有软件开发公司需要的文档功能于一身的系统。
我们姑且叫它:文件系统
技术栈:
jdk17+SpringBoot3+Vue3+MySQL8+Docker Compose
因为是让AI开发的,这里就不扯具体的实现细节,只聊需求,项目已经开源:
https://gitee.com/sean_project/apidoc.git
感兴趣的同学可以去看下。
具体效果:
  1. 用户可以注册、登录;
  2. 登录进去后可以创建项目、或者选择已有项目;
3. 进入项目后就可以实现对这个项目的所有资源进行操作:
  1. 项目概况,接口、状态码、项目文档和项目成员数量统计;
  2. 项目接口列表,主要是所有接口的呈现,重点是接口里面的操作;
    1. 接口请求和响应参数定义、示例;
    2. 前面的示例可以作为测试输入,并且可以修改并测试接口数据,测试结果作为历史请求和响应,该结果也可以作为测试回填、再次请求等。
  3. 状态码,为什么会有这个?2个目的:
    1. 是对端开发可以参考对应错误码做业务处理;
    2. 是运维可以基于错误码处理用户问题。
  4. 项目文档,这里主要是涵盖:数据库文档、设计文档、部署文档,
    1. 数据库文档,支持SQL表结构导入生成列表格式的文档,并且补充文档说明等等,文档也是Markdown所见即所得格式,修改非常顺手;
    2. 设计文档,纯Markdown格式,所见即所得的编辑模式;
    3. 部署文档,也是纯Markdown格式,同时支持添加其他脚本文件,支持新增多个类型SQL、Shell脚本等。
  5. 环境管理,这里主要是测试接口的时候,可以指定发送到的环境,比如测试环境、研发环境、灰度环境、生产环境等;
  6. 项目成员,这里可以添加相关干系人,成员加进来才能进入项目查看和对应的编辑操作。
以前一个想法要做成系统少则2-3天,多则半个月,现在AI是真方便,小半天就可以做的很好了,而且是超预期效果。
核心思想:企业最好是自己能够抓住所有信息资产,尤其是软件公司,AI之后、竞争力都是非常脆弱的,文档/代码如何保证安全?靠谁都没用。

    米兰体育,优秀企业首选的互联网供应服务商

    米兰体育秉承"专业团队、品质服务" 的经营理念,诚信务实的服务了近万家客户,成为众多世界500强、集团和上市公司的长期合作伙伴!

    米兰体育成立于2001年,擅长网站建设、网站与各类业务系统深度整合,致力于提供完善的企业互联网解决方案。米兰体育提供PC端网站建设(品牌展示型、官方门户型、营销商务型、电子商务型、信息门户型、微信小程序定制开发、移动端应用(手机站、APP开发)、微信定制开发(微信官网、微信商城、企业微信)等一系列互联网应用服务。


    我要投稿

    姓名

    文章链接

    提交即表示你已阅读并同意《个人信息保护声明》

    专属顾问 专属顾问
    扫码咨询您的米兰体育专属顾问!
    专属顾问
    马上咨询
    XML 地图