2장. 서비스 관리

프로세스

1. OpenAPI 기능을 정의하려면 다음을 수행합니다.

   1. 호출하려는 서비스의 OpenAPI 사양 파일을 식별하고 액세스합니다.

   2. OpenAPI 사양 파일을 src/main/resources/specs 와 같은 워크플로우 서비스 디렉터리에 복사합니다.

      다음 예제에서는 곱셈 REST 서비스에 대한 OpenAPI 사양을 보여줍니다.

      곱셈 REST 서비스 OpenAPI 사양의 예

      openapi: 3.0.3
      info:
        title: Generated API
        version: "1.0"
      paths:
        /:
          post:
            operationId: doOperation
            parameters:
              - in: header
                name: notUsed
                schema:
                  type: string
                required: false
            requestBody:
              content:
                application/json:
                  schema:
                    $ref: '#/components/schemas/MultiplicationOperation'
            responses:
              "200":
                description: OK
                content:
                  application/json:
                    schema:
                      type: object
                      properties:
                        product:
                          format: float
                          type: number
      components:
        schemas:
          MultiplicationOperation:
            type: object
            properties:
              leftElement:
                format: float
                type: number
              rightElement:
                format: float
                type: number

   3. 워크플로우에서 함수를 정의하려면 OpenAPI 사양의 operationId 를 사용하여 함수 정의에서 원하는 작업을 참조합니다.

      온도 변환 애플리케이션의 함수 정의 예

      {
         "functions": [
           {
             "name": "multiplication",
             "operation": "specs/multiplication.yaml#doOperation"
           },
           {
             "name": "subtraction",
             "operation": "specs/subtraction.yaml#doOperation"
           }
         ]
      }

   4. 함수 정의가 src/main/resources/specs 디렉터리에 저장된 OpenAPI 파일의 올바른 경로를 참조하는지 확인합니다.

2. 워크플로우 상태에서 정의된 함수에 액세스하려면 다음을 수행합니다.

   1. 추가한 함수 정의를 호출하는 워크플로우 작업을 정의합니다. 각 작업이 이전에 정의한 함수를 참조하는지 확인합니다.

   2. functionRef 속성을 사용하여 이름으로 특정 함수를 참조합니다. OpenAPI 사양에 정의된 매개 변수를 사용하여 functionRef 의 인수를 매핑합니다.

      다음 예제에서는 요청 본문 대신 요청 경로의 매핑 매개변수에 대해 보여줍니다. 다음 PetStore API 예제를 참조할 수 있습니다.

      워크플로우에서 함수 인수 매핑 예

      {
         "states": [
          {
            "name": "SetConstants",
            "type": "inject",
            "data": {
              "subtractValue": 32.0,
              "multiplyValue": 0.5556
            },
            "transition": "Computation"
          },
          {
            "name": "Computation",
            "actionMode": "sequential",
            "type": "operation",
            "actions": [
              {
                "name": "subtract",
                "functionRef": {
                  "refName": "subtraction",
                  "arguments": {
                    "leftElement": ".fahrenheit",
                    "rightElement": ".subtractValue"
                  }
                }
              },
              {
                "name": "multiply",
                "functionRef": {
                  "refName": "multiplication",
                  "arguments": {
                     "leftElement": ".difference",
                     "rightElement": ".multiplyValue"
                  }
                }
              }
            ],
            "end": {
              "terminate": true
            }
          }
        ]
      }

   3. OpenAPI 사양의 Operation Object 섹션을 확인하여 요청의 매개변수를 구조화하는 방법을 알아봅니다.
   4. jq 표현식을 사용하여 페이로드에서 데이터를 추출하여 필요한 매개변수에 매핑합니다. OpenAPI 사양에 따라 엔진에서 매개변수 이름을 매핑하는지 확인합니다.

   5. 본문 대신 요청 경로에 매개 변수가 필요한 작업의 경우 OpenAPI 사양의 매개변수 정의를 참조하십시오.

      요청 본문 대신 요청 경로의 매핑 매개변수에 대한 자세한 내용은 다음 PetStore API 예제를 참조하십시오.

      매핑 경로 매개변수 예

      {
        "/pet/{petId}": {
          "get": {
            "tags": ["pet"],
            "summary": "Find pet by ID",
            "description": "Returns a single pet",
            "operationId": "getPetById",
            "parameters": [
              {
                "name": "petId",
                "in": "path",
                "description": "ID of pet to return",
                "required": true,
                "schema": {
                  "type": "integer",
                  "format": "int64"
                }
              }
            ]
          }
        }
      }

      다음은 함수 호출의 예로, 요청 경로에 petId 라는 하나의 매개변수만 추가됩니다.

      PetStore 함수 호출 예

      {
        "name": "CallPetStore", 1
        "actionMode": "sequential",
        "type": "operation",
        "actions": [
          {
            "name": "getPet",
            "functionRef": {
              "refName": "getPetById", 2
              "arguments": { 3
                "petId": ".petId"
              }
            }
          }
        ]
      }

      1

      CallPetStore 와 같은 상태 정의

      2

      함수 정의 참조. 이전 예에서 함수 정의 getPetById 는 PetStore OpenAPI 사양입니다.

      3

      인수 정의. OpenShift Serverless Logic은 요청을 보내기 전에 인수 petId 를 요청 경로에 추가합니다.

프로세스

1. 구성할 OpenAPI 사양 파일을 찾습니다. 예를 들면 substraction.yaml 입니다.
2. 문자(예: . )를 밑줄로 바꾸고 문자를 소문자로 변환하여 파일 이름을 유효한 구성 키로 변환합니다. 예를 들어 substraction.yaml 을 substraction_yaml 로 변경합니다.

3. 구성 키를 정의하려면 변환된 파일 이름을 REST 클라이언트 구성 키로 사용합니다. 다음 예와 같이 이 키를 환경 변수로 설정합니다.

   quarkus.rest-client.subtraction_yaml.url=http://myserver.com

4. application.properties 파일에서 하드 코딩 URL을 방지하려면 다음 예와 같이 환경 변수 대체를 사용합니다.

   quarkus.rest-client.subtraction_yaml.url=${SUBTRACTION_URL:http://myserver.com}

   이 예제에서는 다음을 수행합니다.

   • 구성 키: quarkus.rest-client.subtraction_yaml.url
   • 환경 변수: SUBTRACTION_URL
   • 대체 URL: http://myserver.com
5. (SUBTRACTION_URL) 환경 변수가 시스템 또는 배포 환경에 설정되어 있는지 확인합니다. 변수를 찾을 수 없는 경우 애플리케이션은 대체 URL (http://myserver.com) 을 사용합니다.

6. application.properties 파일에 구성 키와 URL 대체를 추가합니다.

   quarkus.rest-client.subtraction_yaml.url=${SUBTRACTION_URL:http://myserver.com}

7. 애플리케이션을 배포하거나 다시 시작하여 새 구성 설정을 적용합니다.