TeamBlog——规范、高效的项目管理知识库
艺萨科技
千日千月
艺萨科技
千日千月
  • Guide
  • 数据库规范
    • 基础规范
    • 通用模型
  • Vue前端框架
    • Guide
    • 通用说明
    • Element-admin-web
    • Arco-Design-web
  • Java服务端框架
    • Guide
    • 通用说明
    • JPA的封装
    • jDaoMySQL的使用
    • jCoder代码生成
    • 应用配置文件
  • PHP服务端框架
    • Guide
    • schedule定时任务
    • 数据库表、字段的命名原则
    • 接口文档自动生成
    • 队列
    • 日志管理
    • 接口加密
    • 文件的处理
    • RBAC的权限控制(待补充)
    • 一些工具
    • 一些写法
    • env说明
    • 公共的方法
  • 通用能力
    • Guide
    • Web文件预览
    • 统计平台
    • KeyCloak
    • 综合工具平台
    • 内网穿透
    • IM能力
    • 安全扫描

showdoc

经过与呱呱团队交流,通过showdoc代码注释的方案生成接口文档更好一些,目前Gcoder在生成代码时,直接将接口文档生成,建议后续可以用类似于Swagger的方案,进行接口文档的生成

请参考showdoc文档 https://www.showdoc.cc/page/741656402509783,一般情况下,我会把showdoc_api.sh放置在各个模块的Controller下,以便于比较便捷地生成文档

一般只针对UserPortal、AdminPortal这样需要外放接口Controller自动生成文档

Last Updated:: 1/9/23, 6:03 PM
Contributors: mtt-Ada@yisa.art
Prev
数据库表、字段的命名原则
Next
队列