eggjs-common-api

server-config-api

基于Egg.js的 RESTful API 工程,用于快速集成开发RESTful前后端分离的服务端。

特性

  • 框架选择:基于 Egg.js 2.0
  • 🔒 授权验证:基于JWT
  • 🚀 内置功能:文件处理,用户系统,统一错误处理及接口返回标准,全方位CRUD,分页,模糊查询的等数据操作Demo
  • 最佳实践:接口设计适配 Ant Design Pro 或 微信小程序开发等。(内置分页及ant接口返回标准)

QuickStart

see egg docs for more detail.
see mongoose docs for more detail.

Development

$ cd app & mkdir public & cd public & mkdir uploads
$ npm i
$ npm run dev
$ open http://localhost:7001/

Deploy

$ npm start
$ npm stop

npm scripts

  • Use npm run lint to check code style.
  • Use npm test to run unit test.
  • Use npm run autod to auto detect dependencies upgrade, see autod for more detail.

工程结构

eggjs-api
├── README.md
├── README.zh-CN.md
├── app
│   ├── controller
│   │   ├── home.js
│   │   ├── mock.js
│   │   ├── role.js
│   │   ├── user.js
│   │   └── userAccess.js
│   ├── extend
│   │   ├── RESTfulHTTPStatus.rec
│   │   ├── context.js
│   │   ├── helper.js
│   │   └── note.rec
│   ├── middleware
│   │   └── error_handler.js
│   ├── model
│   │   ├── attachment.js
│   │   ├── role.js
│   │   └── user.js
│   ├── router.js
│   └── service
│       ├── actionToken.js
│       ├── role.js
│       ├── upload.js
│       ├── user.js
│       └── userAccess.js
├── appveyor.yml
├── config
│   ├── config.default.js
│   └── plugin.js
├── logs
│   └── eggjs-api
│       ├── common-error.log
│       ├── egg-agent.log
│       ├── egg-schedule.log
│       ├── egg-web.log
│       └── eggjs-api-web.log
├── package.json
└── tools

Visit original content creator repository
https://github.com/Swenson1992/eggjs-common-api

Comments

Leave a Reply

Your email address will not be published. Required fields are marked *