# snake-service

**Repository Path**: seebin/snake-service

## Basic Information

- **Project Name**: snake-service
- **Description**: 快速API开发，Mock挡板工程之后端工程
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2019-05-20
- **Last Updated**: 2021-11-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SNAKE-API

## 描述

灵蛇出动 快速挡板接口工程之后端工程 使用NestJS框架

> Nest 是一个用于构建高效，可扩展的 Node.js 服务器端应用程序的框架。它使用渐进式 JavaScript，内置并完全支持 TypeScript（但仍然允许开发人员使用纯 JavaScript 编写代码）并结合了 OOP（面向对象编程），FP（功能编程）和 FRP（功能反应编程）的元素。
>  
> 在底层，Nest使用强大的 HTTP Server 框架，如 Express（默认）和 Fastify。Nest 在这些框架之上提供了一定程度的抽象，但也可以将其 API 直接暴露给开发人员。这样可以轻松使用每个平台的无数第三方模块。

## 安装应用依赖

```bash
# 安装依赖
$ yarn install
```

## 运行应用

```bash
# 开发启动
$ yarn webpack

# 另一个窗口执行
$ yarn start

# 生产环境启动
$ yarn start:prod
```

## 待办事项

中间件要查询过滤要转发的接口

意思:请求的接口既不是数据库中的mock地址（中间件去查询）也不是web端用到的地址（nestjs中的路由），这时进入一个通配的路由（*）将这个接口代理到指定的环境ip

## Swagger-UI

需要启动后端工程, 才能访问

Swagger 访问地址: [http://localhost:7000/swagger](http://localhost:7000/api)

Swagger JSON文件: [http://localhost:7000/swagger-json](http://localhost:7000/api-json)

Swagger 使用说明: [http://note.youdao.com/noteshare?id=70eb966e6b39456fbc0775c13f8671f1](http://note.youdao.com/noteshare?id=70eb966e6b39456fbc0775c13f8671f1)

## 相关链接

[NestJS 中文网](https://docs.nestjs.cn/6/firststeps)

[NestJS 英文网](https://docs.nestjs.com)

[Entity与DTO区别及其使用](https://my.oschina.net/u/1033181/blog/1573923)

[Nest.js 项目搭建](https://www.jianshu.com/p/622ede9a2d81)

[学习路线参考](https://github.com/nest-cn-community/issues-box/issues/6)

[Mac安装和使用MongoDB](https://www.jianshu.com/p/7241f7c83f4a)

[Mac电脑 设置Mongodb终端命令行启动后可以关闭终端命令行](https://note.youdao.com/ynoteshare1/index.html?id=f79dfdef618bac0ef86ebf5c861c2de3&type=note)

[NodeJS中文网](http://nodejs.cn/api/)

[mongoose 英文官网](https://mongoosejs.com/)

[mongoose 中文官网](http://mongoosejs.net/)

## 许可证

[MIT licensed](LICENSE).