Как проектировать API с учетом REST

Question

Accepted Answer

RESTful API проектируется вокруг ресурсов, а не действий. Основные принципы:

1. Используйте существительные в URL вместо глаголов:
 - Плохо: `/getUsers`
 - Хорошо: `/users`

2. Используйте HTTP методы правильно:
 - GET - получение ресурса
 - POST - создание
 - PUT/PATCH - обновление
 - DELETE - удаление

3. Версионирование в URL или заголовках:
 - `/api/v1/users`

4. Фильтрация, сортировка через query-параметры:
 - `/users?active=true&sort=-created_at`

Пример структуры:
# Flask пример
@app.route('/api/v1/users', methods=['GET', 'POST'])
def users():
 if request.method == 'GET':
 return jsonify(get_all_users())
 elif request.method == 'POST':
 return create_user(request.json)

@app.route('/api/v1/users/<int:user_id>', methods=['GET', 'PUT', 'DELETE'])
def user(user_id):
 if request.method == 'GET':
 return jsonify(get_user(user_id))
 elif request.method == 'PUT':
 return update_user(user_id, request.json)
 elif request.method == 'DELETE':
 return delete_user(user_id)

Важно: возвращайте правильные HTTP статусы (200, 201, 400, 404 и т.д.) и используйте JSON для данных.

Как проектировать API с учетом REST

Следующий вопрос