RESTful API 서버

QHttpServer 를 사용하여 RESTful API 서버를 만드는 예제.

Qt HTTP RESTful API 서버

이 예제는 QHttpServer 클래스를 사용하여 소규모 애플리케이션 내에서 간단한 RESTful 웹 API를 생성하고 호스팅하는 방법을 보여줍니다. 이 서버는 REST 스타일의 호출을 수신하며, 클라이언트 측에서 함께 제공되는 예제인 RESTful 색상 팔레트 API 클라이언트와 연동하여 사용할 수 있습니다.

REST 제약 조건을 준수하는 애플리케이션을 비공식적으로 ‘RESTful’이라고 부를 수 있습니다. 이 RESTful API 서버는 색상(Reqres API와의 호환성을 위해 정의되지 않은 리소스) 및 사용자에 대한 생성, 읽기, 업데이트, 삭제(CRUD) 작업을 지원합니다. 또한 로그인/로그아웃 기능도 제공합니다. 이 예제는 Reqres API를 기반으로 합니다.

서버 애플리케이션을 실행하려면 서버 바이너리를 실행하십시오:

./colorpaletteserver

또는

./colorpaletteserver --port 1234

선택 사항인 ` port ` 매개변수를 지정하여 서버가 실행될 포트를 설정할 수 있습니다.

httpServer.route(
        QString("%1").arg(apiPath), QHttpServerRequest::Method::Get,
        [&api](const QHttpServerRequest &request) { return api.getPaginatedList(request); });

위의 예제에서는 GET 메서드에 대한 경로가 지정되어 있으며, 이 메서드는 저장된 항목의 페이지별 목록이 포함된 JSON 배열을 반환합니다. 이를 위해 ` QHttpServer::route()` 메서드에 ` QHttpServerRequest::Method::Get ` 열거형을 함께 사용합니다.

httpServer.route(QString("%1/<arg>").arg(apiPath), QHttpServerRequest::Method::Get,
                 [&api](qint64 itemId) { return api.getItem(itemId); });

엔티티 목록에서 단일 항목을 가져오려면 요청 쿼리에 항목 ID를 전달합니다.

httpServer.route(QString("%1").arg(apiPath), QHttpServerRequest::Method::Post,
                 [&api, &sessionApi](const QHttpServerRequest &request) {
                     if (!sessionApi.authorize(request)) {
                         return QHttpServerResponse(
                                 QHttpServerResponder::StatusCode::Unauthorized);
                     }
                     return api.postItem(request);
                 });

이 예제에서 경로는 POST 메서드를 허용하며, 이 메서드는 항목 목록에 새 항목을 추가하고 추가된 항목을 나타내는 JSON 객체를 반환합니다. 이 요청은 인증을 거쳐야 합니다. 요청을 인증하려면 TOKEN 헤더의 값이 api/login 또는 api/register 메서드에서 이전에 반환된 토큰과 동일해야 합니다.

QHttpServerResponse postItem(const QHttpServerRequest &request)
{
    const std::optional<QJsonObject> json = byteArrayToJsonObject(request.body());
    if (!json)
        return QHttpServerResponse(QHttpServerResponder::StatusCode::BadRequest);

    const std::optional<T> item = factory->fromJson(*json);
    if (!item)
        return QHttpServerResponse(QHttpServerResponder::StatusCode::BadRequest);
    if (data.contains(item->id))
        return QHttpServerResponse(QHttpServerResponder::StatusCode::AlreadyReported);

    const auto entry = data.insert(item->id, *item);
    return QHttpServerResponse(entry->toJson(), QHttpServerResponder::StatusCode::Created);
}

POST 메서드는 JSON 객체 형태의 새 항목 외에도 다양한 HTTP 상태 코드를 반환합니다. 새 항목의 경우 Created, 기존 항목의 경우 AlreadyReported 입니다. 이 예제는 QHttpServerResponse::QHttpServerResponse 의 오버로드를 사용하여 JSON 객체와 해당 HTTP 상태 코드를 전송합니다.

항목을 생성하려면 요청 본문이 JSON 객체여야 하며, email, first_name, last_name 및 avatar 필드를 포함해야 합니다(새 사용자 생성 시). 예를 들면 다음과 같습니다:

{
    "email": "jane.doe@qt.io",
    "first_name": "Jane",
    "last_name": "Doe",
    "avatar": "/img/faces/1-image.jpg"
}

파일:

이미지:

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.