# docs-vuepress-api

**Repository Path**: srxboys/docs-vuepress-api

## Basic Information

- **Project Name**: docs-vuepress-api
- **Description**: vuepress 写 后台接口文档 - api docs
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 3
- **Created**: 2021-03-14
- **Last Updated**: 2024-09-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vuepress api -> docs

<b>[VuePress](https://vuepress.vuejs.org/zh/) 写 后台`接口文档`</b>

这个文档仅仅是针对 [VuePress](https://vuepress.vuejs.org/zh/) 采用 `Vue - components`二次封装的 docs框架。

为了测试 `Vue - components`能调用api，项目也提供了 `API Server`(Nodejs -> [Express](https://www.expressjs.com.cn/))

## 环境
- [Node.js](https://nodejs.org/zh-cn/) 版本 >= `8.6`

## 框架
1. [VuePress  `1.8.2`](https://vuepress.vuejs.org/zh/)
1. [axioss  `0.21.1`](http://www.axios-js.com/)

## 安装 & 运行
VuePress 运行
```sh
  # 1. 安装 Node.js 依赖库
  npm install

  # 1. 本地测试
  npm run dev

  # 2. VuePress 输出静态资源(打 正式 包)
  npm run build
```

<br>

[Api Server](https://gitee.com/srxboys/docs-vuepress-api/tree/master/server) &nbsp;&nbsp; 测试/验证 <b>docs-vuepress-api</b>访问接口能力
```sh
  # 1. 进入 [api server]的目录  server
  cd server

  # 2. 安装 Node.js 依赖库
  npm install

  # 3.1 运行测试环境 - 本地文件发生改变，重启服务
  npm run dev

  # 3.2 运行测试环境 - 仅仅是跑服务，文件改变需要重启
  npm run serve

  # 4. ESLint: 针对 *.js 文件进行语法检查
  npm run lint
```

## 同时运行 2个项目
- 终端1 去运行 api-docs
- 终端2 去运行 api-server

## 注意
为了在 终端/chrome 打印控制台输出 代码提示日志，
<br>
导致 `npm run dev` / `npm run build` 都会输出一些代码逻辑日志
<br>
如果你要应用你的项目中，最好注释掉(或者删掉)