기술 문서: Egg.js를 사용하여 백엔드 서비스 API 구축(컬렉션 시리즈)

js를 배우던 중 Egg.js를 접하고 자세히 공부하게 되었습니다. Alibaba에서 출시한 Koa 기반 노드 개발 프레임워크로 엔터프라이즈급 프레임워크 및 애플리케이션용으로 설계되었습니다. 백엔드 서비스 API를 구축하는 방법은 추가 연구가 필요합니다. 이번 글에서는 백엔드 서비스 API를 구축하기 위한 Egg.js를 주로 소개하고 있으니 필요하시면 참고하시면 됩니다.

작성전에

일반적인 개발은 프론트엔드와 백엔드 분리 모드이기 때문에 Egg를 이용하여 백엔드 서비스를 만들고 API 세트를 작성할까 생각도 했습니다 다른 프로젝트와 협력하기 위한 인터페이스. 이 프로젝트의 기술 스택은 Egg.js, MongoDB 및 mongoose를 사용합니다. 이 글은 등록 및 로그인 모듈과 사용자 센터 모듈을 작성하는 과정을 적시에 요약하고 문서화 기술을 연습하며 모든 사람과 공유하고 소통하며 함께 진행하는 것이 목적입니다.

프로젝트 주소: Egg-API

프로젝트가 계속 업데이트되고 있으니 좋아요, 좋아요, 별표, 포크 부탁드립니다. 장기적으로 유지하려면 (.＿. ) ✎＿

다음은 텍스트입니다

요구사항 분석

등록 및 로그인 모듈용 , 요구 사항 분석은 다음과 같습니다.

# 🎜🎜#
• 신규 사용자로 등록하고 입력한 데이터를 확인합니다

• 시스템에 로그인하고 토큰 인증을 기반으로 입력된 데이터를 확인합니다. 사용자 센터 모듈에서 개인 정보 보기#🎜 🎜#

사용자 센터 모듈에서 개인 정보 수정
Data 분석 설계

• 명시적 데이터:

• userName: 문자열 사용자 이름

userPass : 문자열 계정 비밀번호

#🎜 🎜#

userEmail: 문자열 사용자 이메일

• telphone: 문자열 휴대폰 번호#🎜🎜 #
• #🎜 🎜#avatar: 문자열 아바타

• age: 숫자 연령

# 🎜🎜#sex: 문자열 성별
City: String City
암시적 데이터:

• #🎜 🎜#userRole: 숫자 사용자 역할 (1. 일반 사용자, 2. 관리자, 3. 최고 관리자, 기본 사용자는 일반 사용자, 최고 관리자는 데이터베이스 생성 시 생성됩니다)
• #🎜 🎜#

  userCreate: 날짜 사용자 생성 시간

• lastLoginTime: 날짜 마지막 로그인 시간

  #🎜 🎜#
#🎜🎜 #laseLoginPlace: 문자열 마지막 로그인 주소

API 분석 및 설계

• 인터페이스 설명의 API 아래는 인터페이스 이름, params는 들어오는 Data, code는 응답 결과 식별 코드, msg는 응답 결과 정보 설명, data는 응답에서 성공적으로 반환된 데이터를 의미합니다

  #🎜🎜 #등록 인터페이스

api: /api/v1/signup  (post)

params: {
    userName: String,  // 用户名，具有唯一性
    userPass: String,  // 用户密码
    userEmail: String,  // 用户邮箱
}

code: 1、注册成功 0：输入信息不完善或有误 -1：注册失败，该用户名已存在

msg: 响应返回的信息说明

data： {
    _id: _id,
    userName: 用户名,
    token: 生成的token,
}

• 로그인 인터페이스

  api: /api/v1/signin  (post，请求头带token)
  
  params: {
      userName: String,  // 用户名
      userPass: String,  // 用户密码
  }
  
  code: 1、登录成功 0：输入信息不完善或有误  -1：用户不存在
  
  msg: 响应返回的信息说明
  
  data: {
      _id： _id，
      userName: 用户名,
      lastLoginTime: 上次登录时间,
      lastLoginPlace: 上次登录地点,
  }

  # 🎜🎜#로그아웃 인터페이스

  api: /api/v1/signout  (get)
  
  code: 1、登出成功，前端退出系统并清空token
  
  msg: 登出响应返回信息说明
  
  data: {}

개인정보 보기 인터페이스

• api: /api/v1/user/userName  (post，请求头带token)
  
  params: {
      userName: String,
  }
  
  code: 1、查询成功  0、输入信息不完善  -1、查询失败
  
  msg: 查找个人信息返回信息说明
  
  data: {
      userName: 用户名,
      userEmail: 用户邮箱,
      age: 年龄,
      city: 城市,
      ......
  }

  개인정보 변경 인터페이스

  api: /api/v1/user/userName (put,token)
  
  params: {
      ......  // 更改的信息
  }
  
  code: 1、更新成功 0、输入信息不完善或有误 -1、更新失败
  
  msg: 更新个人信息返回信息说明
  
  data: {
      userName: 用户名,
      ......
  }

코딩 구현
• #🎜🎜 #참고: 전체 내용을 보려면 Egg-API
  로 이동하세요. 이미 프로젝트를 초기화했으며 프로젝트의 디렉터리 구조가 공식 디렉터리 구조와 일치합니다. MongoDB 데이터베이스를 사용하려면 먼저 egg-mongoose를 설치하고 구성 파일을 작성해야 합니다.

// config/plugin.js
exports.mongoose = {
    enable: true,
    package: 'egg-mongoose',
};
// config/config.default.js
config.mongoose = {
    url: 'mongodb://127.0.0.1/apiExample',
    options: {},
};

모델 폴더에 스키마 파일을 정의합니다.

const UserSchema = new Schema({
    userName: { type: String, unique: true, required: true, },
});

#🎜🎜 # 경로 정의:

router.post('/api/v1/signup', controller.user.signup);

controller 쓰기: 사용자 입력을 구문 분석하고 처리 후 해당 결과를 반환하는 데 사용됩니다. 획득한 데이터를 렌더링을 위해 렌더링에 넣은 다음 렌더링된 결과를 브라우저로 보내거나 데이터를 ctx.body에 직접 할당한 다음 json 모드로 반환할 수 있습니다.

class UserController extends Controller {
    // 登录
    async signin() {
        const { ctx } = this;
        const rule = {
            userName: { type: 'string', required: true, message: '必填项' },
            userPass: { type: 'string', required: true, message: '必填项' },
        };
        const signinMsg = ctx.request.body;
        await ctx.validate(rule, signinMsg);
        signinMsg.userPass = ctx.helper.encrypt(signinMsg.userPass);
        const result = await ctx.service.user.signin(signinMsg);
        ctx.body = result;
    }
}

service writing: 비즈니스 로직 레이어를 작성하는 데 사용되며 재사용이 가능합니다. 표시할 정보와 같은 복잡한 데이터의 처리는 데이터베이스에서 얻어야 하거나 타사 서비스를 호출해야 합니다.

class UserService extends Service {
    // 更新用户信息
    async updateUser(userMsg) {
        const { ctx } = this;
        const res = {};
        const result = await ctx.model.User.findByIdAndUpdate(userMsg._id, userMsg);
        res.code = 1;
        res.msg = '用户信息已更改';
        res.data = result;
        return res;
    }
}

간단한 노드 응용 구조는 이러하므로 인터페이스 서비스를 담당하기 위해 Egg.js를 사용합니다. apache php mysql

관련 기사:

Nodejs 웹 서버 구축 방법

Server -엔터프라이즈 웹사이트 백엔드 구축 문제

관련 영상:

고성능 리눅스 서버 구축 영상 튜토리얼

위 내용은 기술 문서: Egg.js를 사용하여 백엔드 서비스 API 구축(컬렉션 시리즈)의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!