README.md

Egg Restapi Module Tool

a example of eggjs2.0, react, antd, dva2.0, webpack, mysql, restful api and other stuff made it work...

you can generate rest api eazily by this tool.

中文 README

update note:

2017-07-10 initial

2017-07-17 egg-restapi-module-tool v0.9 Released

2017-12-01 update login module with oauth2.0

2018-01-03 update dva to dva2.0

2018-01-04 update egg to egg2.0

Examples for egg

use react, Antd and dva to develop front end modules. use eggjs and mysql to be backend. you can use npm run dev to develop both side's service. or use it as a boilerplate.

this example include two modules: 1 modules manager : module table's CRUD operation, 2 request manager : an note for restful api witch is generated by module tool.

Develop

Installation

install mysql start mysql import testdb.sql to mysql

npm i egg-bin --save-dev
npm install

Start up：

run npm to start server

npm run dev

Go to http://localhost:8080 。

also you can : npm run dev_static to start front react project npm run server to start egg server npm run dev to start both

Distribute

$ npm run build
$ npm run pro

npm run build to build the front end react project. npm run pro in server to start project on you server visit http://serverIP:7001

REST API Example

api/restql/users GET List

{
"meta":{"total":3},
"data":[
{"_id":"58d8a899f5f2486f1f6d4236","uid":1,"name":"admin","pass":"123","status":1,"time":"1325472736"},
{"_id":"58db7828a14b14815447cf33","name":"sdf","pass":"123","status":1,"time":"1325472736","uid":3,"__v":0},
{"_id":"58db7d3bcee4d48df6f5bdfd","name":"sdddf","pass":"123","status":1,"time":"1325472736","uid":4,"__v":0}
]
}

api/restql/users/1 GET Single Data

{
"meta":{"total":1},
"data":[
{"_id":"58d8a899f5f2486f1f6d4236","uid":1,"name":"admin","pass":"123","status":1,"time":"1325472736"}
]
}

api/restql/users/2 PUT Update data with uid

{"name":"admin123","pass":"123","status":1,"time":"1325472736"}

api/restql/users POST insert data

{"name":"admin123","pass":"123","status":1,"time":"1325472736"}

same with news and news_type for rest api data.

screen shot

Thank you

egg

ant-design

antd-admin