a morph lib.
- analysis project dependencies
Use the specific description file to generate an egg application.
- egg controllers
- egg services
- egg router
- egg config
config file
# egg.yml
version: '1.0.0'
models:
user:
- id: number
- name: string
- mail: string
- nickname: string
controllers:
user:
routes:
- route: /user/:id
method: GET
auth: 'BASIC_LOGIN'
description: get user detail by user id
services:
user:
methods:
- name: getUserById
description: get user detail by user id
request:
- name: id
type: number
required: true
description: user id
response:
type: any
description: user detail
- name: getUserByName
description: get user detail by user name
request:
- name: name
type: string
required: true
description: user name
- name: privateInfo
type: boolean
required: false
description: show private user info
response:
type: any
description: user detail
description: user service
plugins:
- buc
- aclservices code
// services/user.ts
import { Service } from 'egg';
/**
* user service
*/
export default class UserService extends Service {
/**
* get user detail by user id
* @param {number} id - user id
* @return {any} user detail
*/
public async getUserById(id: number): Promise<any> {
return this.ctx.proxy.user.getUserById(id);
}
/**
* get user detail by user name
* @param {string} name - user name
* @param {boolean} privateInfo - show private user info
* @return {any} user detail
*/
public async getUserByName(name: string, privateInfo?: boolean): Promise<any> {
return this.ctx.proxy.user.getUserByName(name, privateInfo || null);
}
}yarnyarn testyou can debug with Visual Studio Code (Jest).