Express 4로 편안한 API 생성

Express 4의 출시로 RESTFUL API를 만들기가 더 쉬워졌습니다. 단일 페이지 앱을 작성하는 경우 CRUD 작업을 지원하는 편안한 웹 서비스가 필요합니다. 마지막 자습서는 Angular의 $ 리소스를 사용하여 단일 페이지 CRUD 앱을 만드는 데 중점을 두었습니다. 이 튜토리얼은 Express 4를 사용하여 CRUD 앱의 백엔드 API를 설계하는 방법을 설명합니다. Express 3 이후로 많은 변화가 있었음에 주목하십시오.이 튜토리얼은 앱을 Express 3에서 Express 4로 업그레이드하는 방법을 설명하지 않습니다. 오히려 Express 4로 API를 직접 작성하는 방법을 다룰 것입니다. 그래서 시작하자.

키 테이크 아웃

Express 4는 RESTFUL API의 생성을 단순화하여 CRUD 애플리케이션을위한 백엔드 API를보다 쉽게 ​​설계 할 수 있도록합니다. Express 4는 더 이상 Express Core의 일부가 아니기 때문에 Body-Parser를 별도로 다운로드해야합니다. 이 모듈은 들어오는 요청 본문을 구문 분석하는 데 사용되며, req.body를 통해 게시물 요청 본문에 액세스 할 수 있습니다. express 4 method express.router ()는 중간 전쟁과 경로를 정의 할 수있는 새 라우터 인스턴스를 만듭니다. 이 라우터 인스턴스는 app.use ()를 호출하여 다른 미들웨어와 마찬가지로 기본 앱에서 사용할 수 있습니다. Express 4는 Get, Post, Put 및 Delete와 같은 표준 HTTP 방법을 지원하여 데이터베이스에서 CRUD 작업,이 경우 영화 데이터베이스에서 CRUD 작업을 수행합니다. 이것은 이러한 HTTP 요청을 처리하는 경로를 작성함으로써 이루어집니다.

영화 앱 에 대한 API 만들기 우리의 앱은 기본 CRUD 작업을 지원하는 간단한 영화 데이터베이스가 될 것입니다. 우리는 Express 4를 웹 프레임 워크로 사용하고 Mongoosejs를 객체 모델링 도구로 사용합니다. 영화 항목을 저장하기 위해 MongoDB를 사용합니다.

더 나아 가기 전에 API가 어떻게 생겼는지 살펴 보겠습니다.

디렉토리 구조 우리는 앱에서 다음 디렉토리 구조를 사용할 것입니다 :
• .
• 위의 디렉토리 구조에 대한 몇 가지 점이 있습니다 :
> 빈/www.js는 앱을 부트 스트랩하는 데 사용됩니다 모델 디렉토리는 몽구스 모델을 저장합니다. 이 앱의 경우 Movie.js라는 파일 하나만 있습니다. 경로 디렉토리는 모든 익스프레스 경로를 저장합니다 app.js는 Express 앱의 구성을 보유합니다
• 마지막으로, node_modules 및 package.json은 node.js 앱의 일반적인 구성 요소입니다. 필요한 종속성을 얻는 API를 만들려면 다음 모듈을 사용합니다.
Express Body Parser 몽구스

참고-Body-Parser는 더 이상 Express Core의 일부가 아닙니다. 모듈을 별도로 다운로드해야합니다. 그래서 우리는 그것을 package.json에 나열했습니다이 패키지를 얻으려면 Package.json의 종속성으로 나열합니다. 다음은 package.json 파일입니다

방금 NPM 설치를 실행하면 모든 종속성이 다운로드되어 node_modules 디렉토리 아래에 배치됩니다. 모델 생성 영화 데이터베이스 용 API를 구축하기 때문에 영화 모델을 만들 것입니다. movie.js라는 파일을 만들고 모델 디렉토리에 넣습니다. 아래에 표시된이 파일의 내용은 몽구스 모델을 만듭니다.

이전 스 니펫에서 우리는 새로운 모델 인 영화를 만듭니다. 각 영화에는 제목, 출시 연도, 감독 및 장르와 관련된 4 가지 속성이 있습니다. 마지막으로, 우리는 모델을 모듈에 넣어 외부에서 액세스 할 수 있도록 모델을 모듈에 넣습니다. 경로 만들기 모든 경로는 경로/movies.js로 이동합니다. 시작하려면 Movies.js 파일에 다음을 추가하십시오

<span>{
</span>  <span>"name": "Movie CRUD API",
</span>  <span>"version": "0.0.1",
</span>  <span>"private": true,
</span>  <span>"scripts": {
</span>    <span>"start": "node ./bin/www"
</span>  <span>},
</span>  <span>"main":"./bin/www",
</span>  <span>"engines": {
</span>     <span>"node": "0.10.x"
</span>   <span>},
</span>  <span>"dependencies": {
</span>    <span>"express": "~4.2.0",
</span>    <span>"body-parser": "~1.0.0",
</span>    <span>"mongoose": "~3.8.11"
</span>  <span>}
</span><span>}</span>

Express 4에는 Express.Router ()라는 새로운 메소드가있어 새로운 라우터 인스턴스를 제공합니다. 중간 및 경로를 정의하는 데 사용할 수 있습니다. Express 라우터의 흥미로운 점은 미니 응용 프로그램과 같습니다. 이 라우터를 사용하여 중간 및 경로를 정의한 다음 App.use ()를 호출하여 다른 미들웨어와 마찬가지로 기본 앱에서 사용할 수 있습니다. 모든 영화를 얻는 사용자가 GET 요청을 /API /영화에 보내면 모든 영화가 포함 된 응답을 보내야합니다. 다음은 이것을위한 경로를 만드는 스 니펫입니다.

<..> router.route () 하나 이상의 HTTP 동사를 구성하는 데 사용할 수있는 단일 경로 인스턴스를 반환합니다. 여기서 우리는 GET 요청을 지원하고자합니다. 따라서 우리는 get ()을 호출하고 요청이 도착하면 호출되는 콜백을 통과합니다. 콜백 내부에서 우리는 Mongoose를 사용하여 모든 영화를 검색하고 JSON으로 클라이언트에게 다시 보냅니다. 새로운 영화 만들기 우리의 API는 /API /영화에 대한 게시물 요청이 작성 될 때 데이터베이스에서 새 영화를 만들어야합니다. JSON 문자열은 요청 본문으로 보내야합니다. 우리는 동일한 경로, /영화를 사용하지만 get () 대신 post ()를 사용합니다.

여기 코드는 다음과 같습니다

여기서, 우리는 요청 본문에서 새 영화 인스턴스를 만듭니다. 바디 파서가 사용되는 곳입니다. 그런 다음 새 영화를 저장하고 작전이 성공했음을 나타내는 응답을 보냅니다.

<span>var mongoose=require('mongoose');
</span><span>var Schema=mongoose.<span>Schema</span>;
</span>
<span>var movieSchema = new Schema({
</span>  <span>title: String,
</span>  <span>releaseYear: String,
</span>  <span>director: String,
</span>  <span>genre: String
</span><span>});
</span>
module<span>.exports = mongoose.model('Movie', movieSchema);</span>

메소드는 get (), post () 등에 주목하십시오. 동일한 경로 인스턴스를 반환하십시오. 따라서 아래 그림과 같이 이전 두 호출을 실제로 체인 할 수 있습니다.

영화 업데이트

사용자가 영화를 업데이트하려면/api/movies/: id를 요청 본문으로 보내야합니다. 이름이 지정된 매개 변수 : ID를 사용하여 기존 영화에 액세스합니다. MongoDB를 사용하면서 모든 영화에는 _id라는 고유 한 식별자가 있습니다. 따라서 매개 변수를 검색하고 ID를 사용하여 특정 영화를 찾는 데 사용합니다. 이를 수행하는 코드는 다음과 같습니다

<span>{
</span>  <span>"name": "Movie CRUD API",
</span>  <span>"version": "0.0.1",
</span>  <span>"private": true,
</span>  <span>"scripts": {
</span>    <span>"start": "node ./bin/www"
</span>  <span>},
</span>  <span>"main":"./bin/www",
</span>  <span>"engines": {
</span>     <span>"node": "0.10.x"
</span>   <span>},
</span>  <span>"dependencies": {
</span>    <span>"express": "~4.2.0",
</span>    <span>"body-parser": "~1.0.0",
</span>    <span>"mongoose": "~3.8.11"
</span>  <span>}
</span><span>}</span>

여기서는 새 경로 /영화 /: id를 생성하고 method put ()을 사용합니다. movie.findone ({_id : req.params.id})의 호출은 URL에서 ID가 전달되는 영화를 찾는 데 사용됩니다. 영화 인스턴스가 있으면 요청 본문에서 전달 된 JSON을 기반으로 업데이트합니다. 마지막으로, 우리는이 영화를 저장하고 고객에게 응답을 보냅니다.

영화 검색 단일 영화를 읽으려면 사용자는 Route/API/Movies/: id로 GET 요청을 보내야합니다. 우리는 위와 같은 경로를 사용하지만 이번에는 get ()를 사용합니다.

나머지 코드는 매우 간단합니다. 우리는 통과 된 ID를 기반으로 영화를 검색하여 사용자에게 보냅니다.

영화를 삭제

영화를 삭제하려면 사용자는/api/movies/: id로 삭제 요청을 보내야합니다. 다시, 경로는 위와 동일하지만 메소드는 다릅니다 (예 : delete ()).

<span>var mongoose=require('mongoose');
</span><span>var Schema=mongoose.<span>Schema</span>;
</span>
<span>var movieSchema = new Schema({
</span>  <span>title: String,
</span>  <span>releaseYear: String,
</span>  <span>director: String,
</span>  <span>genre: String
</span><span>});
</span>
module<span>.exports = mongoose.model('Movie', movieSchema);</span>

<..> modive.remove ()는 데이터베이스에서 영화를 삭제하고 성공을 나타내는 사용자에게 메시지를 보냅니다. 이제 우리는 모두 설정되어 있습니다. 하지만 잠깐! 우리는 앱에서 Middlewaree로 사용할 수 있도록 라우터 인스턴스를 Module.export에 넣어야합니다. 그래서 이것은 영화의 마지막 줄입니다.

앱 구성 모든 구성은 app.js로 이동합니다. 필요한 모듈을 요구하는 것으로 시작합니다

다음 단계는 Mongoose를 통해 MongoDB에 연결하는 것입니다 :

마지막으로, 우리는 미들웨어를 구성합니다 :

보시다시피 나는 다른 미들웨어와 마찬가지로 라우터를 사용했습니다. Route Middleware가 /API에 매핑되도록 App.use ()의 첫 번째 인수로 /API를 통과했습니다. 따라서 결국 API URL은 다음과 같습니다

/>/API/영화

//api/movies/: id

<span>var Movie = require('../models/movie');
</span><span>var express = require('express');
</span><span>var router = express.<span>Router</span>();</span>

부트 스트랩 다음 코드는 bin/www.js로 이동합니다.

노드 bin/www.js를 실행하면 API가 위로 올라 가야합니다! api 테스트 이제 API를 만들었으므로 모든 것이 예상대로 작동하는지 확인해야합니다. 크롬 확장자 인 Postman을 사용하여 모든 엔드 포인트를 테스트 할 수 있습니다. 다음은 우체국에서 게시물을 표시하고 요청을받는 몇 가지 스크린 샷입니다.

router<span>.route('/movies').get(function(req<span>, res</span>) {
</span>  <span>Movie.find(function(err<span>, movies</span>) {
</span>    <span>if (err) {
</span>      <span>return res.send(err);
</span>    <span>}
</span>
    res<span>.json(movies);
</span>  <span>});
</span><span>});</span>

결론 이것은 노드와 표현으로 편안한 API를 쉽게 만들 수있는 방법에 대한 기본 개요였습니다. Express를 더 깊이 파고 들으려면 문서를 확인하십시오. 추가하거나 무언가를 묻고 싶다면 자유롭게 의견을 보내주십시오.

앱의 소스 코드는 github에서 다운로드 할 수 있습니다. Express 4

로 편안한 API를 만드는 것에 대한 자주 묻는 질문 (FAQ) 편안한 API와 다른 유형의 API의 차이점은 무엇입니까?

RESTFUL API 또는 표현 상태 전송 API는 REST Architectural Style의 원칙을 준수하는 API의 유형입니다. 이들은 상태가 없으므로 클라이언트에서 서버로의 각 요청에는 요청을 이해하고 처리하는 데 필요한 모든 정보가 포함되어야합니다. 이것은 요청간에 상태를 유지할 수있는 비누와 같은 다른 유형의 API와 다릅니다. RESTFUL API는 또한 Get, Post, Put, Delete와 같은 표준 HTTP 방법을 사용하여 이해하고 사용하기 쉽습니다. Express 4에서 기본 경로를 만드는 방법 4, app.get () 메소드를 사용하여 기본 경로를 만들 수 있습니다. 이 방법은 두 가지 인수, 즉 경로와 콜백 함수를 취합니다. 콜백 함수는 GET 요청이 지정된 경로로 이루어질 때마다 실행됩니다. 예는 다음과 같습니다. app.get ( '/', function (req, res) {});

Express 4에서 게시물 요청을 처리하려면 어떻게해야합니까? 게시물 요청 Express 4, App.Post () 메소드를 사용할 수 있습니다. 이 메소드는 app.get ()과 유사하게 작동하지만 요청이 아닌 게시물 요청에 사용됩니다. 예는 다음과 같습니다. app.post ( '/', function (req, res) { res.send ( 'post request requection'); 언제. 게시물 요청은 루트 경로 ( '/')에 이루어지고 서버는 '사후 요청 수신'으로 응답합니다.

Express 4의 미들웨어는 무엇이며 어떻게 사용합니까? > 미들웨어 함수는 애플리케이션의 요청-응답주기에서 요청 객체 (REQ), 응답 개체 (RES) 및 다음 함수에 액세스 할 수있는 함수입니다. 다음 함수는 Express 라우터의 함수로, 호출되면 현재 미들웨어를 계승하는 미들웨어를 실행합니다. 미들웨어 기능은 다음과 같은 작업을 수행 할 수 있습니다. 모든 코드 실행, 요청 및 응답 개체를 변경하고, 요청-응답주기를 종료하고, 스택에서 다음 미들웨어를 호출하십시오. 4?

Express 4는 내장 오류 핸들러를 제공하며 앱에서 발생할 수있는 오류를 처리합니다. 특정 오류를 처리 해야하는 경우 고유 한 오류 처리 미들웨어 기능을 만들 수 있습니다. 예는 다음과 같습니다. app.use (function (err, req, res, next) { console.error (err.stack);

res.status (500) .send ( 'Something Broke! ');
});
이 예에서는 앱에서 오류가 발생하면 콘솔에 로그인하면 서버가 500의 상태 코드와 메시지로 응답합니다. ‘뭔가 부러졌다!’.
Express 4 경로에서 매개 변수를 어떻게 사용합니까?

경로 매개 변수를 사용하여 URL에서 동적 값을 캡처 할 수 있습니다. 그런 다음이 값은 경로 처리기에서 사용할 수 있습니다. 예는 다음과 같습니다. app.get ( '/user/: userId', function (req, res) {이 예에서, get 요청이 '/user/123'에 GET 요청이 이루어지면 서버는 '사용자 ID가 : 123'으로 응답합니다. express 4?

express 4는 정적 파일을 제공하기 위해 내장 미들웨어 함수 인 Express.static ()을 제공합니다. 이를 사용하여 서버의 디렉토리에서 파일을 제공 할 수 있습니다. 예는 다음과 같습니다. app.use (express.static ( 'public'));
이 예에서 '공개'디렉토리의 파일은 루트 URL ( '/')에서 직접 액세스 할 수 있습니다. <. express body-parser middleware req.body example> var bodyparser = require ( 'body-parser'); app.use (bodyparser.json ()); 이 예에서, 바디 패러 미들웨어는 JSON 및 URL에 인코딩 된 본체를 구문 분석하도록 구성됩니다.
어떻게 수행하십시오. Express 4에서 404 오류를 처리합니다. 다른 경로 처리기 나 미들웨어 기능이 요청을 처리하지 않은 경우이 기능이 실행됩니다. 예는 다음과 같습니다. app.use (function (req, res, next) {이 예에서는 존재하지 않는 경로에 대한 요청이 이루어지면 서버는 404의 상태 코드와 '죄송합니다!'라는 메시지로 응답합니다. Express를 어떻게 사용합니까? express 4?

express 라우터의 라우터는 Express 4의 미니 애플리케이션으로, 경로를 모듈 식 방식으로 구성 할 수 있습니다. express.router ()로 새 라우터를 만들고 미들웨어를 추가하고 경로를 추가 한 다음 app.use ()와 함께 앱에서 사용할 수 있습니다. 예는 다음과 같습니다. var router = express.router (); router.get ( '/', function (req, res) { res.send ( 'hello from the router!'); }); app.use ( '/router', router);

이 예에서는 '/router'에 대한 요청이 작성되면 서버가 ‘라우터에서 안녕하세요!’로 응답하십시오.

위 내용은 Express 4로 편안한 API 생성의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!