Как объявлять маршруты и HTTP-методы?
На этой странице
Маршрут состоит из HTTP-метода, пути и одной или нескольких функций. Express выполняет его, когда запрос совпадает и по методу, и по пути.
Вопрос
Как объявлять маршруты в Express? Какие HTTP-методы для чего используются и почему важен порядок похожих путей?
Основные методы
app.get("/api/users", getUsers);
app.get("/api/users/:id", getUserById);
app.post("/api/users", createUser);
app.put("/api/users/:id", replaceUser);
app.patch("/api/users/:id", updateUser);
app.delete("/api/users/:id", deleteUser);| Метод | Обычное назначение |
|---|---|
GET | Получить данные |
POST | Создать ресурс или запустить действие |
PUT | Полностью заменить ресурс |
PATCH | Частично изменить ресурс |
DELETE | Удалить ресурс |
Порядок похожих маршрутов
Сначала размещай конкретный путь, затем путь с параметром:
app.get("/api/users/me", getCurrentUser);
app.get("/api/users/:id", getUserById);Иначе слово me может быть воспринято как значение id.
Несколько функций в маршруте
app.delete(
"/api/users/:id",
requireAuth,
requireAdmin,
deleteUser,
);Каждая функция либо завершает запрос, либо вызывает next().
app.all()
app.all() реагирует на любой HTTP-метод:
app.all("/api/private/{*path}", requireAuth);В Express 5 символ * в строковом пути должен иметь имя. Чтобы охватить и корневой путь, используется запись {*path}.
HEAD и OPTIONS
HEADпохож наGET, но сервер возвращает только заголовки;OPTIONSсообщает допустимые способы обращения и используется при некоторых CORS-запросах.
Express умеет обрабатывать часть такого поведения автоматически, но на собеседовании полезно понимать назначение методов.
Не помещай действие в адрес без причины
Плохо: POST /api/createUser
Хорошо: POST /api/users
Плохо: POST /api/deleteUser/42
Хорошо: DELETE /api/users/42Что важно помнить
- Конкретный путь (
/users/me) объявляется раньше параметрического (/users/:id). - В Express 5 подстановочный символ в пути должен иметь имя:
/{*path}вместо*. - Один маршрут может содержать цепочку функций: авторизация, проверка роли, обработчик.
- Действие выражается HTTP-методом, а не глаголом в адресе (
DELETE /users/42, а не/deleteUser/42).
Мини-шпаргалка
- Маршрут — это метод, путь и обработчик.
GETчитает,POSTсоздаёт,PATCHизменяет,DELETEудаляет.- Конкретные маршруты размещай раньше параметрических.
- Один маршрут может содержать цепочку обработчиков.
- Адрес обычно называет ресурс, а метод — действие.
Документация
Express: Routing, Express: Migrating to Express 5, MDN: HTTP request methods.