qt_add_openapi_client

제공된 OpenAPI 사양을 사용하여 HTTP 클라이언트를 생성합니다.

이 명령어는 Qt6 패키지의 OpenApiTools 컴포넌트에 정의되어 있습니다. 다음 명령어로 패키지를 불러오십시오:

find_package(Qt6 REQUIRED COMPONENTS OpenApiTools)

이 명령어는 Qt 6.11에서 도입되었습니다.

구문

qt_add_openapi_client(<target>
    SPEC_FILE <file>
    [OUTPUT_DIRECTORY <dir>]
    [ADDITIONAL_PROPERTIES property1=value1 property2=value2 ...]
    [GENERATE_OPTIONS generate_option1 generate_option2 ...]
    [JAVA_OPTIONS jvm_option1 jvm_option2 ...]
    [GENERATE_DOCUMENTATION] # since Qt 6.12
    [DOCUMENTATION_OUTPUT_DIRECTORY <dir>] # since Qt 6.12
    [OUTPUT_PUBLIC_HEADERS_DIR <dir>]
    [OUTPUT_PRIVATE_HEADERS_DIR <dir>]
)

버전 정보가 없는 명령어가 비활성화된 경우, 대신 qt6_add_openapi_client() 을 사용하십시오. 이 명령어는 본 명령어와 동일한 인자 세트를 지원합니다.

설명

qt_add_openapi_client 함수는 제공된 사양 파일에 대해 Qt OpenAPI 생성기를 호출합니다. 그 결과, 이 명령은 소스 파일의 범위를 생성하고 이를 대상 소스 목록에 추가합니다. 대상이 존재하지 않으면 오류 메시지와 함께 생성이 중단됩니다. 대상을 생성하려면 qt_add_library 또는 qt_add_executable 함수를 호출할 수 있습니다.

인수

• SPEC_FILE 코드 생성에 필수적인 OpenAPI 사양 파일을 지정합니다. 파일 확장자는 *.yaml 이어야 합니다.
• OUTPUT_DIRECTORY 생성된 코드의 출력 디렉터리를 지정합니다. 지정하지 않으면 CMAKE_CURRENT_BINARY_DIR 가 사용됩니다.
• ADDITIONAL_PROPERTIES generate 명령에 대한 추가 구성 속성을 지정합니다. 이 속성들은 유효성 검사 없이 있는 그대로 OpenAPI Generator로 전달됩니다.
• GENERATE_OPTIONS generate 명령어에 전달되는 추가 옵션을 지정합니다.

  GENERATE_OPTIONS 를 통해 전달된 -i 및 --input-spec 인수는 무시됩니다. OpenAPI 사양 파일은 SPEC_FILE 인수를 통해서만 설정됩니다.

  GENERATE_OPTIONS 를 통해 전달된 -o 및 --output 인수는 무시됩니다. 출력 디렉터리는 OUTPUT_DIRECTORY 인수를 통해서만 설정됩니다.

• JAVA_OPTIONS OpenAPI Generator를 호출할 때 JVM에 전달되는 추가 옵션을 지정합니다. JVM 동작을 구성할 때 이 옵션을 사용하십시오. 옵션은 유효성 검사 없이 있는 그대로 전달됩니다.
• GENERATE_DOCUMENTATION (Qt 6.12부터) 생성된 클래스에 대한 doxygen 문서를 생성하도록 활성화합니다.
• DOCUMENTATION_OUTPUT_DIRECTORY (Qt 6.12부터) 생성된 클래스에 대한 doxygen 문서를 저장할 디렉터리를 지정합니다. 이 옵션은 GENERATE_DOCUMENTATION 와 함께 사용해야만 합니다.
• OUTPUT_PUBLIC_HEADERS_DIR 생성된 공개 헤더 목록을 저장할 디렉터리를 지정합니다. 지정하지 않으면 헤더는 ` OUTPUT_DIRECTORY`에서 찾을 수 있습니다.
• OUTPUT_PRIVATE_HEADERS_DIR 생성된 비공개 헤더 목록을 저장할 디렉터리를 지정합니다. 지정하지 않으면 헤더는 ` OUTPUT_DIRECTORY`에서 찾을 수 있습니다.

생성 동작 사용자 정의

GENERATE_OPTIONS 및 ADDITIONAL_PROPERTIES 인수를 사용하면 업스트림 OpenAPI 생성기와 Qt 생성기 플러그인 모두의 동작을 사용자 정의할 수 있습니다.

아래 예제는 프로젝트에서 두 인수를 함께 사용하는 방법을 보여줍니다:

qt6_add_openapi_client(ClientExample
    SPEC_FILE
        ${CMAKE_CURRENT_SOURCE_DIR}/example.yaml
    ADDITIONAL_PROPERTIES
        cppNamespace=ExampleNamespace
        modelNamePrefix=Example
    GENERATE_OPTIONS
        --skip-overwrite
        --api-name-suffix MyApiSuffix
)

생성기 인수의 동작 및 지원되는 값은 설치된 OpenAPI Generator 버전에 따라 다르며, 버전 간에 변경될 수 있습니다.

다음 두 가지 방법으로 추가 구성 속성을 지정할 수 있습니다:

• ADDITIONAL_PROPERTIES 인수를 사용하는 방법.
• GENERATE_OPTIONS 인수에 -p 또는 --additional-properties 를 전달하는 방법.

두 방법을 동시에 사용하면 예상치 못한 결과가 발생할 수 있습니다. 한 가지 방법만 선택하는 것을 권장합니다.

JVM 동작 사용자 정의

다음 예제는 대용량 사양 파일을 처리하기 위해 YAML 파서 제한을 늘리고, ` JAVA_OPTIONS`를 사용하여 로그 출력을 경고 수준으로만 줄이는 방법을 보여줍니다:

qt6_add_openapi_client(ClientExample
    SPEC_FILE
        ${CMAKE_CURRENT_SOURCE_DIR}/example.yaml
    JAVA_OPTIONS
        -DmaxYamlCodePoints=99999999
        -Dlog.level=warn
)