절차

1. 웹 브라우저에서 OpenShift 콘솔을 열고 자격 증명(예: 사용자 이름 developer 및 암호 developer)을 사용하여 로그인합니다.
2. API Creator Operator가 포함된 프로젝트를 선택합니다.

3. 토폴로지 를 선택하고 fuse-apicurito 레이블이 지정된 아이콘이 표시되는지 확인합니다.

   apicurito-service-ui 및 apicurito-service-generator 에 대한 아이콘이 있는 경우 OpenShift 관리자가 이미 API Cryostat를 프로젝트에 서비스로 추가하고 나머지 단계를 건너뛸 수 있습니다.

   apicurito-service-ui 및 apicurito-service-generator 에 대한 아이콘이 없는 경우 다음 단계를 계속합니다.

4. 왼쪽 탐색 창에서 추가를 클릭합니다.
5. 개발자 카탈로그 섹션에서 Operator Backed 를 클릭합니다.
6. 검색 필드에 Apicurito 를 입력하여 카탈로그 항목을 필터링합니다.
7. Red Hat 카드가 제공하는 Apicurito 를 클릭합니다.

8. 생성을 클릭합니다.

   API Builder 인스턴스에 대한 최소 시작 템플릿이 있는 기본 양식이 열립니다. 기본값을 허용하거나 선택적으로 편집합니다.

9. 만들기 를 클릭하여 새 API의 pod, 서비스 및 기타 구성 요소의 시작을 트리거합니다.
10. API Creator 서비스가 프로젝트에 추가되었는지 확인하려면 Topology 를 선택한 다음 apicurito-service-ui 및 apicurito-service-generator 에 대한 아이콘이 표시되는지 확인합니다.
11. APIDesign을 열려면 apicurito-service-ui 아이콘에서 URL 링크를 클릭합니다.

1. 명령 창에서 OpenShift 서버에 로그인합니다.

   oc login -u developer -p developer

2. 새 프로젝트 네임스페이스를 생성합니다. 예를 들어 다음 명령은 myproject 라는 새 프로젝트를 생성합니다.

   oc new-project myproject

3. 다음 명령을 실행하여 APIoauth 템플릿을 기반으로 새 애플리케이션을 생성합니다(여기서 myproject 는 프로젝트 이름임).

   oc new-app -n myproject -f https://raw.githubusercontent.com/jboss-fuse/application-templates/application-templates-2.2.0.fuse-sb2-7_11_0-00022-redhat-00001/fuse-apicurito.yml -p ROUTE_HOSTNAME=myhost

   참고: 필요한 경우 oc new-app 명령에 -p 옵션을 추가하여 다른 템플릿 매개변수를 지정할 수 있습니다. 예를 들어 기본 openshift 네임스페이스 이외의 네임스페이스에 OpenShift 이미지 및 템플릿에 Fuse를 설치한 경우 IMAGE_STREAM_NAMESPACE 를 설정하여 Fuse 이미지 스트림이 설치된 네임스페이스를 지정할 수 있습니다.

   oc new-app -n myproject -f https://raw.githubusercontent.com/jboss-fuse/application-templates/application-templates-2.2.0.fuse-sb2-7_11_0-00022-redhat-00001/fuse-apicurito.yml -p ROUTE_HOSTNAME=myhost -p IMAGE_STREAM_NAMESPACE=othernamespace

4. 다음 명령을 실행하여 API Creator 배포의 상태 및 URL을 가져옵니다.

   oc status

   API window가 배포되지 않은 경우 다음 명령을 실행하여 올바른 버전의 apicurito-ui 및 fuse-apicurito-generator 이미지를 설치했는지 확인합니다.

   oc get is -n openshift | grep "apicurito"

5. 브라우저에서 API window에 액세스하려면 제공된 URL(예: https://apicurito.192.168.64.12.nip.io)을 사용합니다.

절차

1. Fuse Online을 사용하는 경우 2 단계로 건너뜁니다.

   OpenShift에서 Fuse를 사용하는 경우:

   1. OpenShift 웹 콘솔에 로그인한 다음 API Creator가 포함된 프로젝트를 엽니다.

   2. OpenShift 4.x의 경우 Topology 를 선택한 다음 apicurito-service-ui 아이콘에서 URL 링크를 클릭합니다.

      OpenShift 3.11의 경우 애플리케이션 목록에서 APIFilter의 URL을 클릭합니다(예: https://apidesigner-myproject.192.168.64.43.nip.io) .

      API의 새 브라우저 창 또는 탭이 열립니다.

      참고

      API Builder는 Apicurio Studio 오픈 소스 프로젝트 의 "조명" 버전이므로 "Apicurio"가 API의 Cryostat 인터페이스에 표시됩니다.

2. New API 를 클릭합니다. 새 API 페이지가 열립니다.

   기본적으로 API Builder는 OpenAPI 3 사양을 사용합니다. OpenAPI 2 사양을 사용하려면 새 API 버튼 옆에 있는 화살표를 클릭한 다음 OpenAPI 2 를 선택합니다.

   참고

   OpenAPI 2 사양을 기반으로 API를 여는 경우, API desktop의 Convert를 OpenAPI 3 옵션으로 사용하여 API 를 변환하여 OpenAPI 3 사양을 준수할 수 있습니다.

3. API 이름을 변경하려면 다음을 수행합니다.

   1. 커서를 이름 위에 마우스로 이동한 다음 표시되는 편집 아이콘( )을 클릭합니다.
   2. 이름을 편집합니다. 예를 들어 Task API 를 입력합니다.
   3. 확인 표시 아이콘을 클릭하여 이름 변경을 확인합니다.

4. 선택적으로 다음을 수행합니다.

   • 버전 번호 및 설명을 입력합니다.
   • 연락처 정보를 추가합니다(이름, 이메일 주소, URL).
   • 라이센스를 선택합니다.
   • 태그를 정의합니다.
   • 하나 이상의 서버를 정의합니다.
   • 보안 스키마를 구성합니다.
   • 보안 요구 사항을 지정합니다.

5. API의 각 개별 끝점에 대한 상대 경로를 정의합니다. 필드 이름은 슬래시(/)로 시작해야 합니다.

   작업 관리 API 예제에 대해 다음 두 경로를 생성합니다.

   • 작업 경로: /todo

   • ID별 특정 작업의 경로: /todo/{id}

     

6. 경로 매개변수 유형을 지정합니다.

   예제 id 매개변수의 경우:

   1. 경로 목록에서 /todo/{id} 를 클릭합니다.

      id 매개변수는 PATH PARAMETERS 섹션에 표시됩니다.

   2. 생성을 클릭합니다.
   3. description: 찾을 작업의 ID를 입력합니다.

   4. 유형에 대해 정수를 32bit 정수 로 선택합니다.

      

7. 데이터 유형 섹션에서 API에 재사용 가능한 유형을 정의합니다.

   1. 데이터 유형 추가를 클릭합니다.
   2. 데이터 유형 추가 대화 상자에서 이름을 입력합니다. 작업 관리 API 예제에 대해 Todo 를 입력합니다.

   3. 선택적으로 API window가 데이터 형식의 스키마를 생성하는 예제를 제공할 수 있습니다. 그런 다음 생성된 스키마를 편집할 수 있습니다.

      작업 관리 API 예제의 경우 다음 JSON 예제로 시작합니다.

      {
          "id": 1,
          "task": "my task",
          "completed": false
      }

   4. 선택적으로 데이터 유형으로 REST 리소스를 생성하도록 선택할 수 있습니다.

   5. 저장을 클릭합니다. 예제를 제공한 경우 API window는 다음 예제에서 스키마를 생성합니다.

      
8. 선택적으로 스키마 속성 편집을 추가하고 새 속성을 추가할 수 있습니다.Optionally, you can add edit the schema properties and add new ones.

9. Task Management API 예제의 경우 문자열 형식의 task 라는 하나의 속성을 사용하여 Task 라는 다른 데이터 유형을 생성합니다.

   

10. 각 경로에 대해 작업(GET, PUT, POST, DELETE, OPTIONS, HEAD 또는 PATCH)을 정의합니다.

    작업 관리 API 예제의 경우 다음 표에 설명된 대로 작업을 정의합니다.

    표 3.1. 작업 관리 API 작업

    경로	작업	설명	요청 본문	응답
    /todo	POST	새 작업을 생성합니다.	미디어 유형: 애플리케이션/json 데이터 유형: Task	상태 코드: 201 설명: 생성된 작업 응답 본문: 미디어 유형: application/json 데이터 유형: Todo
    /todo	GET	모든 작업을 가져옵니다.	해당 없음	상태 코드: 200 설명: 작업 목록
    /todo/{id}	GET	ID로 작업을 가져옵니다.	해당 없음	상태 코드: 200 설명: ID 응답 본문에 대해 발견된 작업: 미디어 유형: application/json 데이터 유형: Task 상태 코드: 404 description: no task with provided identifier found.
    /todo/{id}	PUT	작업을 ID로 업데이트합니다.	요청 본문 유형: Task	상태 코드: 200 설명: 완료됨 상태 코드: 400 설명: 작업이 업데이트되지 않음
    /todo/{id}	DELETE	ID로 작업을 삭제합니다.	해당 없음	상태 코드: 200 설명: 작업이 삭제됨 상태 코드: 400 설명: 작업이 삭제되지 않음

11. API Splunk의 유효성 검사 문제에 설명된 대로 모든 문제를 해결합니다.

12. OpenShift의 Fuse 전용의 경우 Save As 를 클릭한 다음 JSON 또는 YAML 형식을 선택하여 API 사양을 저장합니다.

    JSON 또는 YAML 파일이 로컬 다운로드 폴더에 다운로드됩니다. 기본 파일 이름은 적절한 파일 확장자가 있는 openapi-spec 입니다.

절차

1. 느낌표(!) 아이콘으로 표시된 문제를 찾습니다. 예를 들면 다음과 같습니다.

   

2. 문제에 대한 설명을 보려면 느낌 아이콘을 클릭합니다. 예를 들면 다음과 같습니다.

   

3. 문제 설명에서 제공하는 정보를 기반으로 문제의 위치로 이동하여 수정합니다.

   예를 들어, "작업에 하나 이상의 응답이 있어야 함" 문제를 해결하려면 GET 작업을 클릭하여 응답 추가를 클릭합니다.

   

   응답에 대한 설명을 입력하면 문제가 해결되고 느낌식 아이콘이 사라집니다.

   

4. 모든 문제에 대한 요약은 다음과 같습니다.

   1. 오른쪽 상단에 있는 문제 링크를 클릭합니다.

      

   2. 특정 문제의 문제로 이동하여 문제를 해결할 수 있도록 문제 위치로 이동합니다.

      

절차

1. OpenShift 웹 콘솔에서 API owner가 포함된 프로젝트를 엽니다.

2. API developers console을 엽니다. 프로젝트 애플리케이션 목록에서 apidesigner 아래의 URL을 클릭합니다. 예: https://apidesigner-myproject.192.168.64.38.nip.io

   API Splunk 콘솔이 별도의 웹 브라우저 탭 또는 창에서 열립니다.

3. Open API 를 클릭합니다.

   파일 관리자 창이 열립니다.

4. 파일 관리자 창에서 다음을 수행합니다.

   1. 기존 OpenAPI 정의 파일이 포함된 폴더로 이동합니다(예: openapi.json ).

   2. OpenAPI 정의 파일을 선택한 다음 열기 를 클릭합니다.

      APIPublish 콘솔에서 OpenAPI 정의가 열립니다.

1. 생성 을 클릭합니다.
2. 드롭다운 목록에서 Fuse Camel 프로젝트를 선택합니다.

절차

1. API window가 생성한 camel-project.zip 파일의 압축을 임시 폴더에 압축을 풉니다.
2. Red Hat Developer Studio를 엽니다.
3. Developer Studio에서 파일 → 가져오기 를 선택합니다.
4. 가져오기 대화 상자에서 Maven → Existing Maven 프로젝트를 선택합니다.
5. 편집기 보기에서 프로젝트의 camel-context.xml 파일을 엽니다.

6. REST 탭을 클릭하여 Rest DSL 구성 요소를 편집합니다.

   REST 서비스 정의에 대한 자세한 내용은 Apache Camel 개발 가이드의 " REST 서비스 정의" 섹션을 참조하십시오.

   Swagger 지원을 사용하여 Cryostat-RS 끝점을 확장하는 방법에 대한 자세한 내용은 Apache CXF 개발 가이드를 참조하십시오.

   Fuse Tooling REST 편집기를 사용하는 방법에 대한 자세한 내용은 도구 사용자 가이드의 "Rest DSL 구성 요소 보기 및 편집" 섹션을 참조하십시오.

7. 디자인 탭에서 Camel 경로를 편집합니다.

   Camel 경로 편집에 대한 자세한 내용은 도구 사용자 가이드의 "경로 편집기에서 라우팅 컨텍스트 편집" 섹션을 참조하십시오.

1. OpenShift 클러스터에 로그인합니다.

   $ oc login -u developer -p developer

2. 프로젝트에 대한 새 OpenShift 프로젝트를 생성합니다. 예를 들어 다음 명령은 test-deploy 라는 새 프로젝트를 생성합니다.

   $ oc new-project test-deploy

3. Fuse Camel 프로젝트가 포함된 폴더(예: myworkspace/camel-project)로 디렉터리를 변경합니다.

   $ cd myworkspace/camel-project

4. OpenShift 클러스터에 프로젝트를 빌드하고 배포합니다.

   $ mvn clean fabric8:deploy -Popenshift

5. 브라우저에서 OpenShift 콘솔을 열고 프로젝트(예: test-deploy)로 이동합니다. camel-project 애플리케이션의 Pod가 시작될 때까지 기다립니다.
6. 프로젝트의 개요 페이지에서 camel-project 애플리케이션의 URL을 찾습니다. URL은 이 양식을 사용합니다. http://camel-project-MY_PROJECT_NAME.OPENSHIFT_IP_ADDR.nip.io.
7. URL을 클릭하여 서비스에 액세스합니다.

1. 다음 예와 같이 Fuse 프로젝트의 pom.xml 파일을 편집하여 openshift-maven-plugin 종속성을 포함합니다.

   <plugin>
           <groupId>org.jboss.redhat-fuse</groupId>
           <artifactId>openshift-maven-plugin</artifactId>
           <version>${fuse.version}</version>
           <executions>
             <execution>
               <goals>
                 <goal>resource</goal>
                 <goal>build</goal>
               </goals>
             </execution>
           </executions>
     </plugin>

   OpenShift Maven 플러그인은 특정 프로젝트 수준 조건이 충족되면 Service Discovery Enricher를 실행합니다(예: 프로젝트가 Camel Rest DSL 프로젝트여야 함). 향상된 동작을 사용자 정의하려는 경우( API 서비스 주석 값 사용자 지정에 설명된 대로) pom.xml 파일의 종속성으로 Service Discovery Enricher를 지정할 필요가 없습니다.

2. Fuse Rest DSL 프로젝트의 camel-context.xml 파일에서 restConfiguration 요소에 다음 속성을 지정합니다.

   • scheme: 서비스가 호스팅되는 URL의 스키마 부분입니다. "http" 또는 "https"를 지정할 수 있습니다.
   • contextPath: API 서비스가 호스팅되는 URL의 경로 부분입니다.

   • apiContextPath: API 서비스 설명 문서가 호스팅되는 위치 경로입니다. 문서가 자체 호스팅되는 경우 상대 경로 또는 문서가 외부적으로 호스팅되는 경우 전체 URL을 지정할 수 있습니다.

     예제 camel-context.xml 파일의 다음 발췌 내용은 restConfiguration 요소의 주석 특성 값을 보여줍니다.

     <?xml version="1.0" encoding="UTF-8"?>
     <beans xmlns="http://www.springframework.org/schema/beans"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="
            http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
            http://camel.apache.org/schema/spring       http://camel.apache.org/schema/spring/camel-spring.xsd">
     
         <camelContext xmlns="http://camel.apache.org/schema/spring">
             <restConfiguration component="servlet" scheme="https"
                   contextPath="myapi" apiContextPath="myapi/openapi.json"/>
     ...

1. 선택한 편집기에서 Fuse 프로젝트의 pom.xml 파일을 엽니다.

2. 다음 예와 같이 openshift-maven-plugin 종속성을 찾습니다.

   <plugin>
           <groupId>org.jboss.redhat-fuse</groupId>
           <artifactId>openshift-maven-plugin</artifactId>
           <version>${fuse.version}</version>
           <executions>
             <execution>
               <goals>
                 <goal>resource</goal>
                 <goal>build</goal>
               </goals>
             </execution>
           </executions>
     </plugin>

3. 다음 예와 같이 Fabric8 Service Discovery Enricher를 openshift-maven 플러그인에 종속성으로 추가합니다.

   <plugin>
     <groupId>org.jboss.redhat-fuse</groupId>
     <artifactId>openshift-maven-plugin</artifactId>
     <version>${fuse.version}</version>
     <executions>
       <execution>
         <goals>
           <goal>resource</goal>
           <goal>build</goal>
         </goals>
       </execution>
     </executions>
     <dependencies>
       <dependency>
         <groupId>io.acme</groupId>
         <artifactId>myenricher</artifactId>
         <version>1.0</version>
         <configuration>
           <enricher>
             <config>
               <f8-service-discovery>
                 <scheme>https</scheme>
                 <path>/api</path>
                 <descriptionPath>/api/openapi.json</descriptionPath>
               </f8-service-discovery>
             </config>
           </enricher>
         </configuration>
         </dependency>
     </dependencies>
   </plugin>

4. 변경 사항을 저장하십시오.