/relationship-server-egg-typescript

Egg+Typescript+Mongo+Restful API

Primary LanguageTypeScript

relationship-server

Build Status Coverage Status

提供简单的用户信息管理，为小程序提供服务支持。

  • 基于Egg的框架支持,使用Typescript编写
  • 使用Mongo进行数据存储
  • 提供Github API风格的Restful API
  • 基于json web token的认证方式
  • 完整的类型定义和单元测试支持

middleware & plugin

  • egg-validator
  • egg-mongoose
  • koa-jwt
  • koa-json

API

API文档 ApiDoc生成文档

TODO

  • 对last-modified-since的响应
  • Hyperlink url的支持
  • rate-limit
  • GraphQL

Contributors

Usage

编译ts文件: npm run tsc
本地运行: npm run dev
unittest: npm test

在VS Code中直接按'F5'以调试模式运行，其他参见egg官方文档-本地开发-调试