# 后台模板后端代码

**Repository Path**: a_chao2001/vue_mange_template_server

## Basic Information

- **Project Name**: 后台模板后端代码
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-04-15
- **Last Updated**: 2023-09-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

- 文档地址
  http://119.45.20.162:12121/apidoc/index.html 接口文档
  http://119.45.20.162:8089/vue_mange_template 前端程序地址
  http://119.45.20.162:12121 前端接口请求
  http://demo1.jeeplus.org 目标平台

- 需要全局装一下 apidoc 这个包

- 自动部署(暂未完善)
  > 我在搞一个自动化部署的程序,需要用到 shell 脚本
  > 我的想法是:

1. gitee webhook 钩子 监听 git push 通知服务端
2. 服务端得到通知后,切换到需要更新的程序目录下,执行 git pull
3. 拉取最新代码后,执行 yarn build 命令,因为打包输出目录已经设定在 Nginx 下边,就实现了自动部署

目前这些步骤都已经实现,问题是

1. 假如我本地增加了一个包,这时线上 pull 后再打包,会报缺少某个包,能否有某种方式捕捉到 shell 脚本抛出的错误呢?

@api {method} path [title]
只有使用@api 标注的注释块才会在解析之后生成文档，title 会被解析为导航菜单(@apiGroup)下的小菜单
method 可以有空格，如{POST GET}
@apiGroup name
分组名称，被解析为导航栏菜单
@apiName name
接口名称，在同一个@apiGroup 下，名称相同的@api 通过@apiVersion 区分，否者后面@api 会覆盖前面定义的@api
@apiDescription text
接口描述，支持 html 语法
@apiVersion verison
接口版本，major.minor.patch 的形式
@apiIgnore [hint]
apidoc 会忽略使用@apiIgnore 标注的接口，hint 为描述
@apiSampleRequest url
接口测试地址以供测试，发送请求时，@api method 必须为 POST/GET 等其中一种
@apiDefine name [title] [description]
定义一个注释块(不包含@api)，配合@apiUse 使用可以引入注释块
在@apiDefine 内部不可以使用@apiUse
@apiUse name
引入一个@apiDefine 的注释块
@apiParam [(group)] [{type}] [field=defaultValue] [description]
@apiHeader [(group)] [{type}] [field=defaultValue] [description]
@apiError [(group)] [{type}] field [description]
@apiSuccess [(group)] [{type}] field [description]
用法基本类似，分别描述请求参数、头部，响应错误和成功
group 表示参数的分组，type 表示类型(不能有空格)，入参可以定义默认值(不能有空格)
@apiParamExample [{type}] [title] example
@apiHeaderExample [{type}] [title] example
@apiErrorExample [{type}] [title] example
@apiSuccessExample [{type}] [title] example
用法完全一致，但是 type 表示的是 example 的语言类型
example 书写成什么样就会解析成什么样，所以最好是书写的时候注意格式化，(许多编辑器都有列模式，可以使用列模式快速对代码添加\*号)
@apiPermission name
name 必须独一无二，描述@api 的访问权限，如 admin/anyone