Автор оригинала: Ezekiel Ekunola.
Я буду принимать нас через шаги настройки базового узла API с помощью TypeyScript.
Примечание: у вас должно быть Nodejs Установлен на вашу машину.
Во-первых, для создания нашей папки проекта и инициализируйте его с NPM для генерации Package.json файл.
Установка зависимостей
npm i express --save npm i @types/node @types/express ts-node typescript nodemon --save-dev
Создать tsconfig.json Файл в корне вашего приложения или запуска NPX TSC --init на вашем терминале и добавьте конфигурацию ниже.
{
"compilerOptions":
{
"target": "es6",
"module": "commonjs",
"allowJs": true,
"outDir": "./build",
"rootDir": "./src",
"esModuleInterop": true
}
}
Примечание. К услугам гостей больше опций. tsconfig.json файл. Узнайте больше здесь Отказ
Добавить скрипты в Package.json файл.
"scripts":
{
"dev": "nodemon src/app.ts",
"start": "tsc && node build/app"
}
Создать SRC каталог, где будет построен наше приложение. Внутри SRC каталог, создать app.ts файл.
Внутри app.ts Файл, добавьте код ниже.
import express, { Application, Request, Response, NextFunction } from "express";
const app: Application = express();
app.use(express.json());
app.get("/", (req: Request, res: Response): object => {
return res.json({ status: "success", message: "Welcome to API Service" });
}
);
app.use((req: Request, res: Response, next: NextFunction) => {
const error = new Error("Route Not found");
next(error);
});
app.use((error: { message: string; status: number }, req: Request, res: Response,next: NextFunction
) => {
res.status(error.status || 500);
res.json({
status: "error",
message: error.message
});
next();
}
);
const PORT: any = process.env.PORT || 3000;
app.listen(PORT, () => console.log(`app listening on port ${PORT}`));
На данный момент ваша структура проекта должна выглядеть как изображение ниже.
Развитие 👨🏾💻.
Чтобы запустить приложение в среде разработки, запустите команду ниже
npm run dev
Примечание. Приведенная выше команда компилирует файлы, найденные в каталоге SRC в памяти.
Производство 🚀.
Чтобы запустить приложение в производственной среде, запустите команду ниже
npm start
Примечание. Вышеуказанная команда компилирует файлы, найденные в SRC каталог для построить каталог и запускает файл app.js в построить каталог, как указано выше в Начните скрипт в нашем Package.json файл.
Проект, используемый в этой статье, можно найти здесь Отказ
Если у вас есть какие-либо вопросы или отзывы, пожалуйста, оставьте комментарий.
Спасибо за прочтение.