项目名称

项目的简短描述...

项目目录结构

描述项目的目录结构与各自意义...

数据定义

项目中一些结构体定义、包括数据表定义...

API 定义

定义服务的接口:

  • 路径与方法
  • 请求结构
  • 相应结构
  • 错误处理

开发环境搭建

描述如何在本地跑起来一个开发环境,从而开始开发...

CI/CD

Branch

要构建的仓库分支

ConfigMap

配置文件或插件等 如需写权限或执行权限请注明

PersistentVolume

需要做持久化的文件或目录

Ports

对外暴露的端口

Getaway

暴露到公网请标明域名 网关需要的插件 插件的配置

Linked Service

包括要调用的服务接口数据库等 简单描述即可

InitContainer

如果需要初始化容器 请在此著名