README.md

formalEgg

简单的博客项目, 基于egg.js

QuickStart

see egg docs for more detail.

Development

$ npm i
$ npm run dev
$ open http://localhost:7001/
$ open swagger http://127.0.0.1:7001/public/swagger/index.html

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.

controller下的文件配置

• controller下的文件进行如下配置，以便用于加载swagger

let methodParm = {
    topLogo: {
        role: 'admin',  //角色名，与js文件名相同，也对应于swagger的大分类
        register: {    //  该文件下的方法函数名
            param: {   //   入参参数
                userName: {type: 'string'},
                phone: {type: 'string'},
                password: {type: 'string'},
                realName: {type: 'string',optional: true}
            },
            ginseng: {   //出参参数，因为无法自动判定出参是什么所以需要手动配置
                code: {type: 'int'},
                message: {type: 'string'}
            },
            rule: {      // 配置需要准守的规则，可以自己定义
                desc: '',
                url: '',
                method: 'register'
            }
        },
        login: {
            param: {
                userName: {type: 'string'},
                password: {type: 'string'}
            },
            ginseng: {
                code: {type: 'int'},
                message: {type: 'string'}
            },
            rule: {
                desc: '',
                url: '',
                method: 'login'
            }
        }
    }
    
}
app.loadApiswagger(methodParm);   //将参数配置放到公共组件的扩展方法中

• 目前该处理过程存在一点问题，controller下文件里的方法名不能重复，不然会被覆盖掉，同时router.js里的对应方法也应该对应修改掉
• swagger.js是关于swagger文档格式的拼接方法，其在router.js文件中引入并配置

注册、登录

• 使用的插件为jsonwebtoken
• 在登录时使用jsonwebtoken生成token，使用Redis存放用户个人信息和token信息
• 注销登录就是删除Redis用户信息缓存
• 在忘记密码接口中参数有code，但是没有做生成和验证验证码的模块，可以自己做。