Panduan untuk Membina API REST dengan Rangka Kerja Deno dan Oak

Siaran ini membimbing anda dalam mencipta API REST menggunakan Deno, rangka kerja Oak dan pangkalan data DenoKV.

Kami akan membina API buku mudah untuk melakukan semua ini. Tetapi pertama-tama, mari kita fahami teknologi ini.

Apa itu Deno?

Deno bertujuan untuk menyukarkan Javascript.

Ia melakukan ini dengan membetulkan banyak masalah yang dihadapi pembangun dengan Node. Pendekatan mudah Deno membantu pembangun menulis kod JavaScript yang lebih selamat, cekap dan moden.

Titik jualan besar Deno ialah keselamatannya. Secara lalai, ia tidak membenarkan akses kepada sistem fail, rangkaian atau pembolehubah persekitaran melainkan dibenarkan secara eksplisit oleh pembangun. Deno juga memberi pembangun sokongan TypeScript asli tanpa memerlukan konfigurasi tambahan.

Ciri lain yang disertakan dengan Deno ialah:

• Pustaka standard terbina dalam, menghilangkan keperluan untuk banyak pakej pihak ketiga
• Sistem modul moden, menyokong import berasaskan URL secara langsung
• CLI yang dipertingkatkan dengan alatan terbina dalam untuk pemformatan, linting dan ujian
• Pengalaman JavaScript yang konsisten dengan Modul ES dan bukannya CommonJS.

Apa itu Oak

Oak ialah rangka kerja middleware untuk Deno yang membantu pembangun membina apl web dan API.

Ia memberikan alatan untuk mengendalikan permintaan HTTP, mengurus penghalaan dan menyepadukan perisian tengah, serupa dengan Express dalam Node.js. Oak juga mempunyai TypeScript langsung dari kotak dan mendapat manfaat daripada keselamatan Deno dan persekitaran masa jalan moden. Ini memberikan pembangun sintaks biasa sambil menikmati ciri yang lebih moden.

Oak membolehkan pembangun menggunakan amalan pertama TypeScript dalam persekitaran yang selamat, cekap dan progresif.

Apa itu DenoKV

DenoKV ialah pangkalan data nilai kunci yang mengurus data berstruktur untuk Deno.

Setiap bahagian data atau "nilai" mempunyai pengecam atau "kunci" yang unik, menjadikannya mudah untuk mengambil data dengan merujuk kuncinya. Pendekatan ini membolehkan pembangun mengurus data tanpa menyediakan pelayan pangkalan data yang berasingan. DenoKV sesuai untuk aplikasi ringan dan prototaip pantas.

Pembangun mendapat penyelesaian yang mudah untuk mengurus data terus bersama kod mereka.

Persediaan Projek

Pasang Deno

curl -fsSL https://deno.land/install.sh | sh

Untuk macOS: Menggunakan Shell

irm https://deno.land/install.ps1 | iex

Untuk Windows: Menggunakan PowerShell

curl -fsSL https://deno.land/install.sh | sh

Untuk Linux: Menggunakan Shell
Untuk menguji pemasangan anda jalankan deno -version.

Buat projek baharu

Jalankan arahan deno init deno-oak-demo untuk mencipta projek baharu yang dipanggil deno-oak-demo, kemudian cd ke dalamnya

Seterusnya, anda perlu mencipta 4 fail baharu dalam direktori deno-oak-demo:

• book.routes.ts
• book.dto.ts
• book.types.ts
• Dan pengesahan.ts

Anda ialah direktori deno-oak-demo sekarang sepatutnya kelihatan seperti ini

Pasang Sambungan Deno VSCode

Seterusnya, anda perlu memasang sambungan VSCode rasmi Deno yang menambah sokongan untuk menggunakan Deno dengan Kod Visual Studio.

Pasang Oak

Gunakan arahan deno add jsr:@oak/oak untuk memasang rangka kerja Oak sebagai kebergantungan.
Fail deno.json anda kini sepatutnya kelihatan seperti ini

Setiap kali kami memasang pakej dalam Deno, ia akan diletakkan dalam fail deno.json sebagai import. Kemudian, jika kami ingin mengimport pakej ini ke dalam fail, kami boleh menggunakan alias yang ditakrifkan dalam deno.json atau merujuk terus URL pakej.

Menentukan Jenis dan DTO

Dalam fail book.types.ts tambah kod berikut

curl -fsSL https://deno.land/install.sh | sh

Dan dalam fail book.dto.ts tambahkan ini

irm https://deno.land/install.ps1 | iex

Minta Pengesahan

Tambahkan kod berikut pada validation.ts

curl -fsSL https://deno.land/install.sh | sh

Konfigurasikan Penghala Buku

Untuk bermula, kami akan mengimport Penghala Oak, antara muka Book, createBookSchema dan updateBookSchema ke dalam fail book.routes.ts:

export interface Book {
    id: string;
    title: string;
    author: string;
    description: string;
}

Seterusnya, kami akan memulakan pangkalan data DenoKV dan mencipta tika penghala baharu untuk mengendalikan laluan HTTP.

export interface CreateBookDTO {
    title: string;
    author: string;
    description: string;
}

Seterusnya, kami akan mencipta fungsi pembantu untuk mendapatkan buku mengikut idnya:

import { z } from "https://deno.land/x/zod@v3.17.0/mod.ts";

export const createBookSchema = z.object({
    title: z.string(),
    author: z.string(),
    description: z.string(),
});

export const updateBookSchema = z.object({
    title: z.string().optional(),
    author: z.string().optional(),
    description: z.string().optional(),
});

kv.get mengambil tatasusunan dengan dua rentetan: satu mewakili ruang nama "buku" dan satu lagi mewakili kunci untuk buku tertentu yang sedang diambil.
Seterusnya, mari tentukan pengendali laluan untuk mendapatkan satu buku mengikut id:

import { Router } from "@oak/oak/router";
import type { Book } from "./book.types.ts";
import { createBookSchema, updateBookSchema } from "./validation.ts";

Tidak seperti dalam Express, dalam Oak kedua-dua permintaan dan respons diakses daripada objek konteks, yang mempunyai kedua-dua data permintaan dan kaedah tindak balas, memberikan cara yang diperkemas untuk mengendalikan interaksi HTTP.

Seterusnya, tambahkan pengendali laluan untuk mendapatkan semua buku:

const kv = await Deno.openKv();
const bookRouter = new Router;

Kv.list mendapatkan semula semua pasangan nilai kunci yang berkongsi awalan biasa(ruang nama).

Seterusnya, tambahkan pengendali laluan untuk membuat buku baharu:

async function getBookById(id: string) {
    const entry = await kv.get(["books", id]);
    return entry.value as Book | null;
}

Kv.set boleh digunakan untuk menyimpan pasangan nilai kunci baharu dalam DB, dalam kes ini, ia memerlukan tatasusunan (dengan dua rentetan; ruang nama dan kunci) dan nilai untuk disimpan.

Seterusnya, tambahkan pengendali laluan untuk mengemas kini buku mengikut id:

curl -fsSL https://deno.land/install.sh | sh

kv.set juga boleh digunakan untuk mengemas kini nilai pasangan nilai kunci. Dalam kes ini, ia memerlukan tatasusunan (dengan dua rentetan; ruang nama dan kunci yang nilainya akan dikemas kini) dan nilai baharu untuk dikemas kini.
Akhir sekali, mari tambahkan pengendali laluan untuk memadamkan buku mengikut id:

irm https://deno.land/install.ps1 | iex

kv.delete memadamkan pasangan nilai kunci yang diberikan.

Mulakan Permohonan Oak

Dalam fail main.ts tambah kod berikut:

curl -fsSL https://deno.land/install.sh | sh

Jalankan Apl

Kami perlu membuat sedikit perubahan pada deno.json kami untuk menjalankan apl kami.

export interface Book {
    id: string;
    title: string;
    author: string;
    description: string;
}

Kami telah menambahkan bendera --stable-kv kerana DenoKV masih API yang tidak stabil.

Selain itu, kami telah menambahkan bendera --allow-net untuk memberikan akses Deno net.

Dengan adanya ini, kami boleh memulakan apl kami dengan menjalankan deno run dev.

Kesimpulan

Kami telah sampai ke penghujung siaran.

Kini anda boleh mencipta API REST dengan Deno Oak dan pangkalan data DenoKV.

Atas ialah kandungan terperinci Panduan untuk Membina API REST dengan Rangka Kerja Deno dan Oak. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!