Kod API pertama anda dengan Node.js dan Ekspres: Sediakan pelayan

Dalam tutorial terdahulu, kami belajar tentang seni bina lain, enam kekangan rehat, bagaimana memahami kaedah permintaan HTTP dan kod responsnya, dan komposisi titik akhir API yang tenang.

Tutorial ini akan menyediakan pelayan untuk API kami. Anda boleh membina API menggunakan mana -mana bahasa pengaturcaraan dan perisian pelayan, tetapi kami akan menggunakan Node.js (pelaksanaan backend JavaScript) dan Express (kerangka nod yang popular, minimalis).

Pasang

Premis pertama kami adalah untuk memastikan bahawa Node.js dan NPM dipasang secara global pada komputer. Kami boleh menguji kedua-duanya dengan express-api dan beralih kepadanya.

 Mkdir Express-API && CD Express-API

Sekarang kita berada di direktori baru, kita dapat memulakan projek kami dengan arahan pemasangan bersama -sama dengan setiap pergantungan untuk menyelesaikan persediaan projek.

 NPM Pasang Permintaan MySQL Ekspres Body-parser

Ini akan membuat fail package-lock.json dan direktori node_modules , dan package.json kami akan dikemas kini untuk kelihatan seperti ini:

 {
  "Nama": "Express-app",
  "Versi": "1.0.0",
  "Penerangan": "",
  "Utama": "index.js",
  "Pengarang": "Asyncbanana",
  "Lesen": "MIT",
  "Ketergantungan": {
    "Parser Body": "^1.19.2",
    "Ekspres": "^4.17.3",
    "Mysql": "^2.18.1",
    "Node-Fetch": "^3.2.0"
  }
}

Kemudian kita perlu menambah objek "Skrip". Objek "Skrip" dapat membantu kami menjalankan kod.

 {
  "Nama": "Express-app",
  "Versi": "1.0.0",
  "Penerangan": "",
  "Utama": "index.js",
  "Skrip": {
    "Mula": "Node Index.js"
  },
  "Pengarang": "Asyncbanana",
  "Lesen": "MIT",
  "Ketergantungan": {
    "Parser Body": "^1.19.2",
    "Ekspres": "^4.17.3",
    "Mysql": "^2.18.1",
    "Node-Fetch": "^3.2.0"
  },
  "Jenis": "Modul"
}

Apakah modul Ecmascript?

Modul ECMAScript (atau ESM) adalah spesifikasi baru untuk menyambungkan skrip dalam persekitaran seperti penyemak imbas dan nod. Ia menggantikan spesifikasi lama seperti CommonJs (CJs) yang digunakan oleh nod secara lalai. Dalam tutorial ini, kami akan menggunakan semua ESM.

Sediakan pelayan HTTP

Sebelum mula menyediakan pelayan Express, kami akan menggunakan modul http terbina dalam Node untuk dengan cepat menubuhkan pelayan HTTP dan menetapkan nombor port (saya memilih kaedah createServer() ).

 // Bina pelayan menggunakan modul HTTP Modul Node {CreateServer} dari "http";
const port = 3001;
const server = createServer ();

Dalam artikel REST pengenalan, kami membincangkan permintaan dan tanggapan mengenai pelayan HTTP. Kami akan menyediakan pelayan kami untuk memproses permintaan, memaparkan URL yang diminta di sebelah pelayan, dan memaparkan "Hello, Server!"

 server.on ("permintaan", (permintaan, respons) => {
    console.log (`url: $ {request.url}`);
    response.end ("Hello, Server!");
});

Akhirnya, kami akan memberitahu pelayan yang pelabuhan untuk mendengar dan memaparkan ralat apabila ia muncul.

 // Mulakan pelayan pelayan.listen (port, (error) => {
    jika (ralat) pulangan konsol.log (`ralat: $ {error}`);
    console.log (`pelayan sedang mendengar pada port $ {port}`);
});

Sekarang kita boleh memulakan pelayan dengan menjalankan skrip NPM yang kita buat sebelum ini.

 NPM START

Anda akan melihat respons ini di terminal:

 <code>Server is listening on port 3001</code>

Untuk memeriksa sama ada pelayan sedang berjalan, lawati https://localhost:3001/hello dan anda akan melihat permintaan GET pada direktori akar pelayan ( / terima permintaan, kami akan memaparkan URL yang diminta dan mesej "Hello, Server!").

 app.get ("/", (permintaan, respons) => {
    console.log (`url: $ {request.url}`);
    response.send ("Hello, Server!");
});

Akhirnya, kami memulakan pelayan pada port pada kaedah listen() .

 const server = app.listen (port, (error) => {
    jika (ralat) pulangan konsol.log (`ralat: $ {error}`);
    console.log (`Server Mendengarkan pada port $ {server.address (). port}`);
});

Sekarang kita boleh menggunakan curl -i untuk URL, kita akan melihat bahawa ia kini dikuasakan oleh Express dan terdapat beberapa tajuk tambahan seperti modul POST dan body-parser . Tambah penyata import ke bahagian atas fail index.js .

 Import bodyparser dari "body-parser";
…

Kemudian kami akan memberitahu aplikasi Express kami untuk menggunakan curl -i ke pelayan dan anda akan melihat bahawa header kini kembali ke GET ke direktori root (lanjutan .js tidak diperlukan dalam require . Sekarang kami akan memindahkan penghala aplikasi supaya kami dapat menggunakannya dalam fail index.js .

 // Router Export Export Export Export;

Di index.js , ganti laluan:

 laluan (app);

Anda kini boleh pergi ke pemboleh ubah users dalam routes.js yang mengandungi beberapa data pengguna palsu dalam format JSON.

 pengguna const = [
  {
    ID: 1,
    Nama: "Richard Hendricks",
    E -mel: "richard@piedpiper.com",
  },
  {
    ID: 2,
    Nama: "Bertram Gilfoyle",
    E -mel: "gilfoyle@piedpiper.com",
  },
];

Kami akan menambah lain /users dan menghantar data pengguna melaluinya.

 app.get ("/pengguna", (permintaan, respons) => {
    response.send (pengguna);
});

Selepas memulakan semula pelayan, kini anda boleh menavigasi ke http://localhost:3002/users dan lihat semua data yang kami paparkan.

Nota: Jika anda tidak mempunyai sambungan JSON Viewer pada penyemak imbas anda, saya sangat mengesyorkan anda memuat turun satu, seperti JSONVUE Chrome. Ini akan menjadikan data lebih mudah dibaca!

Lawati repositori GitHub kami untuk melihat kod penuh artikel ini dan bandingkan dengan anda sendiri.

kesimpulannya

Dalam tutorial ini, kami belajar bagaimana untuk menyediakan pelayan HTTP terbina dalam dan pelayan ekspres dalam nod, permintaan laluan dan URL, dan gunakan permintaan untuk menggunakan data JSON.

Dalam isu akhir siri API RESTFul, kami akan menyambungkan pelayan Express kami ke MySQL untuk membuat, melihat, mengemas kini, dan memadam pengguna dalam pangkalan data untuk menyelesaikan fungsi API.

Atas ialah kandungan terperinci Kod API pertama anda dengan Node.js dan Ekspres: Sediakan pelayan. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!