SmartDocs를 사용하여 API 문서화

<ph type="x-smartling-placeholder"></ph> 현재 Apigee Edge 문서를 보고 있습니다.
Apigee X 문서. 정보

를 통해 개인정보처리방침을 정의할 수 있습니다.

SmartDocs를 사용하면 Drupal 7 개발자 포털에서 API를 문서화할 수 있어 완전히 상호작용할 수 있는 API 문서입니다. 대화형 문서를 통해 포털 사용자는 다음 작업을 할 수 있습니다.

  • API 알아보기
  • API에 실시간 요청 보내기
  • API에서 반환된 실시간 응답 보기

API에 대한 대화형 문서를 만들면 포털 사용자가 API를 학습, 테스트, 평가할 수 있습니다.

Edge 관리 API는 HTTP 클라이언트입니다 SmartDocs를 사용하여 에지 관리를 위한 대화형 문서를 만든 Apigee API에 액세스할 수 있습니다. 관련 API 문서는 여기를 참고하세요.

SmartDocs 포털 예시

SmartDocs를 사용하려면 Apigee 개발자 서비스 포털이 있어야 합니다. 자세한 내용은 개발자 만들기

개발자 포털 홈페이지에서 상단 탐색 메뉴의 API를 클릭하여 API 문서 페이지를 확인하세요

포털에는 Hello World와 Pet Store 예시라는 두 가지 API가 문서화되어 있습니다.

Hello World API가 모의 대상 OpenAPI에서 생성됨 사양, mocktarget.yaml. 자세한 내용은 https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi를 참조하세요.

Pet Store Example API는 클래식한 반려동물 스토어 데모를 기반으로 생성되었습니다.

Hello World API 살펴보기:

  1. Hello World API를 클릭합니다. Hello World API 요약 페이지가 표시됩니다.
  2. API 확인 보기를 클릭합니다. 이 리소스의 SmartDocs는 표시됨:
  3. 이 요청 보내기를 클릭합니다.
  4. 반환된 응답을 확인합니다. 
    HTTP/1.1 200 OK
Connection:
keep-alive
Content-Length:
18
Content-Type:
text/html; charset=utf-8
Date:
Tue, 21 Jun 2016 21:49:32 GMT
ETag:
W/"12-Jb9QP1bUxNSmZkxQGt5KLQ"
X-Powered-By:
Apigee
<H2>I <3 APIs</H2>
  5. Request(요청) 탭을 클릭하여 요청을 보거나 cURL을 클릭합니다. Tab 키를 눌러 해당 cURL 호출을 확인합니다.

SmartDocs를 사용하여 API를 문서화하는 방법

SmartDocs는 모델을 사용하여 API를 나타냅니다. 모델에는 API에 대한 정보를 제공합니다 포털은 모델에서 API에 대한 정보를 추출하여 포털의 문서 페이지를 Drupal 노드로 렌더링합니다. 여기서 각 Drupal 노드는 포털의 문서 페이지로 이동합니다

SmartDocs를 사용하기 위한 일반적인 단계는 다음과 같습니다.

  1. 포털에서 Drupal SmartDocs 모듈을 구성합니다.
  2. SmartDocs 모델을 만듭니다.
  3. WADL 파일, OpenAPI (이전의 Swagger)에서 모델에 API를 추가합니다. 지정할 수 있습니다
  4. 모델을 Drupal 노드 모음으로 렌더링합니다. 각 Drupal 노드 에는 단일 API에 대한 정보가 포함됩니다. 예를 들어 API의 리소스가 POST 및 PUT 요청으로 SmartDocs는 POST와 PUT을 위한 별도의 Drupal 노드를 만듭니다.
  5. Drupal 노드를 게시합니다. 게시되면 포털 사용자가 API와 상호작용할 수 있습니다
  6. Drupal 노드를 게시하기 전이나 후에 수정합니다. 다음과 같은 작업을 할 수 있습니다. Drupal 편집기를 사용하거나 원본 WADL 파일을 편집하거나 OpenAPI 사양. WADL 파일 또는 OpenAPI 사양 수정이 완료되면 새 버전으로 모델에 다시 추가한 다음 변경사항을 렌더링하고 게시합니다.
  7. TLS 사용 설정 SmartDocs는 사용자 인증 정보를 백엔드를 API에 요청하는 과정에서 포털에서 TLS를 사용 설정하여 이러한 사용자 인증 정보가 안전한지 확인합니다 포털 프로덕션 및 테스트 환경에서 Apigee는 https:// 요청을 수행하는 데 필요한 TLS 인증서를 제공합니다. 하지만 이 과정을 진행하기 전에 자체 TLS 인증서를 가져와서 TLS를 사용 설정해야 합니다. 자세한 내용은 다음을 참고하세요. 서버에서 TLS를 사용하여

SmartDoc 모델 및 템플릿 정보

포털에서 모델을 만들면 모델이 실제로 Edge에 저장됩니다. Drupal이 아니라 조직입니다 모델은 내부 이름 (예: 'my-smartdocs-api')이며 API의 구조를 정의합니다. 반면에 포털은 모델을 HTML로 렌더링하고 모델에 대한 편집 인터페이스를 제공합니다. API 업데이트 소스 모델로 자동 푸시백됩니다

조직에 저장됨

Drupal에 저장됨

models

templates

수정 기능이 있는 Drupal 노드

조직에 여러 개의 포털이 있다고 가정해 보겠습니다 (예: dev, stage 및 있습니다. Pantheon에서는 포털을 한 환경에서 다른 환경으로 이동합니다. 각 인스턴스는 포털에 자체 모델이 포함되어 있는 것 같지만 모든 모델이 실제로 소스를 참조하고 있습니다. 있습니다. dev에서 API를 수정하면 모델이 업데이트되고 변경사항이 프로덕션에 표시됩니다. 마찬가지로 dev에서 모델을 삭제하면 소스가 삭제되며 있습니다

템플릿은 SmartDocs 및 해당 템플릿( 핸들바 및 CSS 파일)은 각 포털 인스턴스와 함께 저장됩니다. 따라서 각 포털은 이론적으로 각 모델에 고유한 템플릿을 사용합니다 하지만 렌더링 프레임워크의 장점 중 하나는 기본 템플릿 (Apigee 기본 템플릿 또는 사용자가 제공한 템플릿)이 적용할 수 있습니다

다음 다이어그램은 모델과 포털 간의 관계를 보여줍니다. 녹색 화살표는 자동 동기화도 지원합니다.

다음 cURL 명령어는 조직의 모든 모델을 나열합니다.

curl -v https://api.enterprise.apigee.com/v1/o/{your_org}/apimodels/ -u edge_org_admin@example.com

SmartDocs 모듈 구성

Apigee는 SmartDocs를 커스텀 Drupal 모듈로 구현했습니다. 다음 절차를 따르세요. SmartDocs 모듈을 구성합니다.

<ph type="x-smartling-placeholder">

SmartDocs 모듈을 구성하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. Drupal 관리 메뉴에서 Modules를 선택합니다. 모든 설치된 Drupal 모듈이 표시됩니다.
  3. SmartDocs 모듈을 사용 설정합니다.
  4. 구성을 저장합니다.
  5. Drupal 관리자 메뉴에서 Modules를 선택합니다.
  6. SmartDocs ->를 선택합니다. 권한을 클릭하고 '관리 수행 작업 수행" (예: '관리자') 역할이 사용 설정되어 있는지 확인합니다
  7. 구성 > Drupal 관리의 Dev Portal 선택합니다.
  8. 연결 시간 제한 및 요청 제한 시간을 16으로 설정합니다. 초입니다.
  9. 구성을 저장합니다.
  10. URL 설정을 구성합니다. <ph type="x-smartling-placeholder">
      </ph>
    1. 구성 > 검색 및 메타데이터 > URL 별칭 > 설정을 선택합니다.
    2. 별칭 최대 길이 및 구성요소 최대 길이 길이를 255로 설정합니다.
    3. 구두점을 펼칩니다.
    4. 왼쪽 중괄호 ({) 및 오른쪽 중괄호 (}) 설정에서 작업 없음 (바꾸지 않음)을 선택합니다.
    5. 구성 저장을 클릭합니다.
  11. 개발자 포털이 API의 하위 집합이 비공개 네트워크에 있는 경우 SmartDocs API를 구성합니다. 프록시 URL로 대체해야 합니다. <ph type="x-smartling-placeholder">
      </ph>
    1. 구성 > Drupal 관리의 SmartDocs 선택합니다.
    2. 고급 설정을 펼칩니다.
    3. SmartDocs 프록시 URL 필드를 다음과 같이 업데이트합니다. <host>/smartdocs/v1/sendrequest입니다.
      인라인 도움말은 사용자 환경에 필요한 값을 제공합니다. 예를 들면 다음과 같습니다.
      https://api-us-east-1-enterprise.apigee.com/smartdocs/v1/sendrequest

      이 필드의 기본값은 https://apiconsole-prod.apigee.net/smartdocs/v1/sendrequest
    4. 구성 저장을 클릭합니다.

모델 만들기

모델에는 API 표현에 대한 모든 정보가 포함되어 있습니다. 사용자는 포털에 여러 모델을 추가하여 다양한 API를 지원하거나 모든 API를 단일 있습니다.

각 모델은 Drupal 노드를 생성했습니다 각 Drupal 노드의 URL은 다음과 같은 형식입니다.

http://<drupalBasePath>/<internalName>/apis/<httpMethod>/<resourcePath>

각 항목의 의미는 다음과 같습니다.

  • drupalBasePath: 포털의 기본 URL입니다.
  • internalName: 모델의 내부 이름입니다.
  • httpMethod: API의 HTTP 메서드(예: get, put, post 또는 삭제합니다.
  • resourcePath: 리소스 경로입니다.

예를 들어 내부 이름을 'mymodel'로 지정하면 생성된 '/books'라는 리소스에 대한 GET 요청의 Drupal 노드 다음과 같습니다.

http://prod-myco.devportal.apigee.com/mymodel/apis/get/books

모델 만들기

모델을 만들면 Edge 조직에 API의 소스로 저장됩니다. 있습니다. 자세한 내용은 SmartDoc 모델 정보 및 템플릿을 참조하세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 콘텐츠 > Drupal 관리의 SmartDocs 선택합니다.
  3. 페이지 상단의 새 모델을 선택합니다.
  4. 다음 입력란을 입력합니다. <ph type="x-smartling-placeholder">
      </ph>
    • 이름: 사이트 전체에 표시될 모델 이름입니다.
    • 내부 이름: 이름을 입력하면 내부 표시됩니다. 모든 모델에서 고유해야 하는 모델의 내부 이름입니다. 내부 이름에는 공백 없이 소문자, 숫자, 하이픈만 포함해야 합니다. 이 이름을 수정하려면 수정을 선택합니다.
    • 설명: 모델에 대한 설명입니다.
  5. 모델 만들기를 선택합니다.

모델을 만들면 모델 페이지로 리디렉션됩니다. 여기에서 작업 드롭다운 bx를 사용하여 다음을 수행합니다.

  • API를 설명하는 WADL 파일을 가져오거나 OpenAPI의 URL을 지정합니다. API를 설명하는 사양입니다.
  • 모델에 버전 추가
  • 설정을 수정합니다. 있습니다.
  • 모델을 파일로 내보냅니다.
  • 모델을 삭제합니다.

모델에 API 추가

다음 방법으로 모델에 API를 추가할 수 있습니다.

  • API 정의가 포함된 WADL 파일 가져오기
  • OpenAPI 사양 가져오기 (OpenAPI 2.0 또는 1.2)
  • 리소스 및 메서드 수동으로 만들기

SmartDocs JSON 파일을 모델로 가져올 수도 있습니다. 이 파일은 일반적으로 먼저 기존 모델을 내보내고 파일을 수정한 다음 업데이트를 가져와야 합니다 자세한 내용은 '모델 내보내기 및 가져오기'를 참조하세요. 참조하세요.

동영상: 짧은 동영상을 시청하고 다음 방법으로 SmartDocs 모델에 API를 추가하는 방법을 알아보세요. 가져올 수 있습니다

WADL 가져오기

모델을 성공적으로 만든 후에는 API를 설명하는 WADL 파일을 가져옵니다. 매회 WADL 파일을 가져올 때 모델의 새 버전이 자동으로 생성됩니다.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 콘텐츠 > Drupal의 SmartDocs 관리 메뉴
  3. 업데이트할 모델을 선택합니다.
  4. 작업에서 가져오기를 선택합니다.
  5. 드롭다운 메뉴의 형식 선택 드롭다운에서 WADL을 선택합니다. SmartDocs 가져오기 페이지
  6. 업로드에서 파일 또는 URL을 선택합니다. 유형 드롭다운을 클릭합니다.
    1. 파일을 선택한 경우 WADL 파일을 찾습니다.
    2. URL을 선택하는 경우 WADL 파일의 URL을 지정합니다.
  7. 가져오기를 클릭하여 모델로 가져옵니다. 이제 할 수 있습니다. 모델을 렌더링해야 합니다
  8. 이제 모델의 정보 페이지로 리디렉션되어 있습니다.

OpenAPI 가져오기 사양

모델을 성공적으로 만든 후 OpenAPI (이전의 Swagger)를 가져올 수 있습니다. 사양. Edge는 OpenAPI 버전 1.2 및 2.0을 지원합니다.

OpenAPI는 JSON 객체가 포함된 파일을 사용하여 API를 설명합니다. 데이터를 가져올 때마다 OpenAPI 사양에 따라 모델의 새 버전을 자동으로 만듭니다.

<ph type="x-smartling-placeholder">

OpenAPI 사양을 가져오려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 선택 콘텐츠 > SmartDocs의 Drupal 관리 메뉴
  3. 업데이트할 모델을 선택합니다.
  4. 작업에서 가져오기를 선택합니다.
  5. Swagger JSON 또는 Swagger YAML을 선택합니다. SmartDocs 가져오기 페이지에서 형식 선택 드롭다운을 선택합니다.
  6. 다음에서 파일 또는 URL을 선택합니다. 업로드 유형 드롭다운 (OpenAPI 1.2의 경우 URL을 선택해야 함)
    1. 파일을 선택한 경우 OpenAPI로 이동합니다. 사양.
    2. URL을 선택하는 경우 OpenAPI의 URL을 지정합니다. 사양.
  7. 가져오기를 클릭하여 모델로 가져옵니다.
  8. 이제 모델의 정보 페이지로 리디렉션되어 있습니다.

수동으로 리소스 만들기 및 메서드

API를 나타내는 WADL 파일 또는 OpenAPI 사양이 없는 경우 모델에 API를 수동으로 추가할 수 있습니다. 또한 WADL 파일 또는 OpenAPI 사양을 사용하여 모델을 수정한 후에는 이 절차를 사용하여 새 API를 추가하는 것을 포함하여 API를 편집할 수 있습니다. 가져올 수 있습니다

API를 수동으로 추가하려면 다음 안내를 따르세요.

  1. 모델의 새 버전을 만듭니다.

    버전을 만들 때 모델에 있는 모든 API의 단일 기본 경로를 지정합니다. 즉, 모델의 모든 API가 동일한 기본 경로를 공유합니다. 예를 들어 기본 경로를 형식:

    https://myCompany.com/v1

    모델에 리소스를 추가하면 기본 경로가 확장됩니다.
  2. 모델에 하나 이상의 리소스를 정의합니다. 리소스 경로는 기본 경로와 결합됩니다. 모델의 전체 URL을 지정합니다. 예를 들어 리소스가 는 '/login'의 경로를 정의하며 리소스의 전체 URL은 다음과 같습니다.

    https://myCompany.com/v1/login
  3. 각 리소스에 대해 하나 이상의 메서드를 정의합니다. 메서드는 리소스에서 호출됩니다. 예를 들어 '/login'의 경우 사용자는 로그인을 위해 POST를 지원하고 로그아웃: DELETE 이 리소스는 PUT 또는 GET과 같은 다른 HTTP 동사를 지원하지 않습니다. 따라서 리소스에 대해 두 개의 메서드, 즉 POST용 메서드와 DELETE용 메서드를 정의합니다.

    이 메서드는 상위 리소스의 리소스 URL을 사용합니다. 따라서 URL은 SmartDocs의 단일 리소스 아래에 정의됩니다.

일반적인 규칙은 다음과 같습니다.

  • API의 고유한 기본 경로마다 서로 다른 SmartDocs 모델을 만듭니다.
  • API의 각 고유한 리소스에 대해 서로 다른 SmartDocs 리소스를 정의합니다.
  • 리소스에서 지원하는 각 HTTP 동사에 대해 서로 다른 SmartDocs 메서드를 정의합니다.

모델의 새 버전 만들기

모델의 기존 버전에만 리소스를 추가할 수 있습니다. 모델에 이미 리소스를 추가할 수 있습니다 모델이 새 모델이며 버전이 없는 경우 새 모델을 만듭니다. 있습니다.

모델의 새 버전을 만들려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 선택 콘텐츠 > SmartDocs Drupal 관리 메뉴로 이동합니다
  3. 업데이트할 모델에서 버전 추가를 선택합니다. 작업에서 확인할 수 있습니다.
  4. API 버전 추가 페이지에서 다음 정보를 입력합니다. <ph type="x-smartling-placeholder">
      </ph>
    • 표시 이름: 있습니다.
    • 버전 ID: 버전의 짧은 식별자입니다.
    • 설명: 버전에 대한 설명입니다.
    • 기본 URL: 모델 버전에 있는 모든 API의 기본 URL입니다. 가 모델은 버전마다 다른 기본 URL을 사용할 수 있습니다 예를 들어 표시 URL을 지정합니다. 첫 번째 모델 버전의 기본 URL은
      입니다. https://myCompany.com/v1
      다음 버전의 기본 URL은 다음과 같습니다.
      https://myCompany.com/v2
  5. 버전 추가를 선택합니다. 모델의 버전 페이지로 리디렉션됩니다. 이제 모델에서 리소스를 정의할 수 있습니다.

리소스 정의

리소스는 API의 전체 URL을 지정합니다. 리소스를 정의할 때 리소스 경로: 모델 버전의 기본 URL과 결합되어 전체 URL이 생성됩니다. 리소스 중 하나이며

리소스를 정의하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 선택 콘텐츠 > SmartDocs의 Drupal 관리 메뉴로 이동합니다
  3. 업데이트할 모델의 작업에서 API를 선택합니다. 버전: 모델의 모든 버전을 볼 수 있습니다.
  4. 수정할 버전을 선택하세요.
  5. 버전 페이지의 드롭다운 메뉴에서 리소스 추가를 선택합니다.
  6. Add Resource 페이지에서 다음 정보를 입력합니다. <ph type="x-smartling-placeholder">
      </ph>
    • 표시 이름: 리소스의 이름입니다.
    • 경로: '/'로 시작하는 리소스 경로입니다. 이 Path는 모델 버전의 Base URL과 결합됩니다. 리소스의 전체 URL을 만듭니다
    • 설명: 리소스에 대한 설명입니다.
    • 매개변수: 필요한 경우 각 매개변수를 정의하는 JSON 객체를 입력합니다. 리소스에서 실행됩니다 이러한 매개변수는 아래에 설명되어 있습니다.
  7. 리소스 추가를 선택합니다. 모델 페이지로 리디렉션됩니다. 이제 할 수 있습니다. 리소스를 정의할 수 있습니다

원하는 경우 템플릿, 쿼리, 헤더와 같은 매개변수를 리소스에 추가할 수 있습니다. 매개변수입니다. 모든 리소스 매개변수는 해당 리소스에 정의된 메서드에 의해 상속됩니다. 따라서 리소스에 쿼리 매개변수를 정의하면 해당 리소스에 추가된 모든 메서드가 가 해당 쿼리 매개변수를 지원해야 합니다.

또는 메서드에 매개변수를 정의할 수 있습니다. 예를 들어, POST 메서드는 DELETE 메서드에서 지원되지 않는 쿼리 매개변수가 포함됩니다. 따라서 는 아래에 설명된 대로 특정 메서드와 관련된 메서드 고유의 이름을 지정할 수 있습니다.

다음 이미지는 의 기존 SmartDocs 페이지를 보여줍니다. 각 매개변수 유형이 강조 표시된 Apigee 승인 또는 개발자 앱 취소 API:

각 매개변수 유형은 JSON 객체로 정의됩니다.

유형

JSON 개체

참고

템플릿

{
"dataType": "string",
"defaultValue": "",
"description": "조직 이름",
"이름": "조직_이름",
"required": true,
"type": "TEMPLATE"
}

템플릿 매개변수는 항상 필요하므로 required를 true로 설정하고 값을 생략합니다. defaultValue로 설정합니다.

description 값 사용자가 SmartDocs 페이지에서 URL 위로 마우스를 가져가면 팝업에 표시됩니다.

쿼리

{
"dataType": "string",
"defaultValue": "",
"description": "위치.",
"name": "w",
"required": true,
"type": "QUERY"
}

필수 쿼리 매개변수는 defaultValue를 지정할 수 있지만 지정하지 않는 경우가 많습니다.

선택사항인 쿼리 매개변수의 경우 required를 false로 설정하고 defaultValue로 설정합니다.

헤더

{
"dataType": "string",
"defaultValue": "애플리케이션/json",
"description": "<code>application/json</code>으로 지정합니다.",
"name": "콘텐츠-유형",
"required": true,
"type": "HEADER"
}

설명에서 HTML 태그를 사용하는 방법을 확인하세요.

템플릿 매개변수는 리소스 경로에 변수를 정의합니다. 예를 들어, 사용할 수 있습니다. 매개변수 배열에서 각 매개변수 정의가 는 쉼표로 구분됩니다.

[
 {
  "dataType": "string",
  "defaultValue": "",
  "description": "Mention the organization name.",
  "name": "org_name",
  "required": true,
  "type": "TEMPLATE"
 },
 {
  "dataType": "string",
  "defaultValue": "",
  "description": "Mention the user email.",
  "name": "developer_email",
  "required": true,
  "type": "TEMPLATE"
 }
]

그런 다음 "{}"로 묶인 리소스 경로 정의에서 템플릿 매개변수를 사용할 수 있습니다. 예를 들어 경로를 다음과 같이 설정합니다.

/login/{org_name}/{developer_email}

SmartDocs API 페이지에서 사용자는 먼저 URL의 org_name 및 developer_email 부분을 지정하도록 URL을 수정해야 합니다. 요청을 제출할 수 있습니다

메서드 정의

각 리소스에 대해 하나 이상의 메서드를 정의합니다. 메서드 정의는 리소스에서 호출할 수 있습니다 리소스에는 단일 메서드를 정의할 수 있습니다. 여러 가지 메서드를 지원합니다.

메서드를 정의하는 과정에서 쿼리 및 헤더 매개변수입니다. 매개변수 추가에 대한 자세한 내용은 위의 설명을 참조하세요. 메서드에 추가합니다.

다음 이미지는 Apigee 개발자 만들기 API의 기존 SmartDocs 페이지를 보여줍니다. 페이지의 각 영역에 광고 단위를 정의할 때 설정한 해당 값으로 메서드를 사용하여 축소하도록 요청합니다.

다음 이미지는 동일한 페이지를 보여주지만 요청 본문의 설명이 선택되어 있습니다.

메서드를 정의하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 선택 콘텐츠 > SmartDocs Drupal 관리 메뉴로 이동합니다
  3. 업데이트할 모델의 작업에서 API를 선택합니다. 버전: 모델의 모든 버전을 볼 수 있습니다.
  4. 수정할 버전을 선택하세요.
  5. 버전 페이지의 다음 중 하나에 대한 드롭다운 메뉴에서 메서드 추가를 선택합니다. 집중할 수 있습니다
  6. 메서드 수정 페이지에서 다음 정보를 입력합니다. <ph type="x-smartling-placeholder">
      </ph>
    • 표시 이름: API의 이름으로, API의 API의 Drupal 페이지
    • 설명: API에 대해 설명합니다.
    • 메서드 동사: HTTP 동사 유형입니다.
    • 보안 스키마: 계정에 대한 인증 모드(있는 경우)를 메서드를 사용하여 축소하도록 요청합니다. 자세한 내용은 SmartDocs 인증 구성 유형을 참조하세요.
    • 콘텐츠 유형: 요청 및 응답의 콘텐츠 유형입니다. 자세한 내용은 섹션을 참조하세요.
    • 매개변수: (선택사항) 메서드의 모든 쿼리 또는 헤더 매개변수입니다. 리소스에 매개변수를 추가하는 방법에 대한 자세한 내용은 위의 설명을 참조하세요.
    • 요청 본문 문서: (선택사항) 요청 본문을 설명합니다. 게시 및 PUT 메서드는 요청 본문을 취합니다. 이 영역을 사용하여 설명할 수 있습니다. 이 코드를 요청 본문 아래의 설명 링크가 생략됩니다. 생성된 SmartDocs 페이지에서 가져옵니다.
    • 요청 본문 예: (선택사항) 요청 본문의 예를 표시합니다. 일반적으로 JSON 객체 또는 XML입니다. POST 및 PUT 동사의 경우 요청 본문 Example이 각 요청의 일부로 전달됩니다. SmartDocs 페이지 사용자가 이 항목을 수정합니다. 예를 들어 API에 요청을 제출하기 전에 확인할 수 있어야 합니다. 이 값을 생략하면 요청 본문 아래의 값 링크는 생성된 SmartDocs 페이지입니다.
    • 태그: API와 연결된 태그의 배열입니다. SmartDocs는 태그를 사용하여 유사한 API를 그룹화합니다 예를 들어 '통계' 태그에 모든 API에 적용 자세히 알아볼 수 있습니다. 여러 리소스의 API를 단일 태그로 그룹화할 수 있습니다. 만약 모두 같은 태그를 사용합니다.
  7. 메서드 추가를 선택합니다. 모델 페이지로 리디렉션됩니다. 이제 할 수 있습니다. 렌더링하고 게시할 수 있습니다.

모델 렌더링

모델에 API를 추가한 후 모델을 렌더링할 수 있습니다. 렌더링은 모델의 Drupal 노드에 입력할 수 있습니다. 렌더링이 완료되면 단일 Drupal이 생깁니다. 노드 1개로 구성됩니다. 여기서 각 Drupal 노드는 HTML 페이지에 해당합니다.

전체 모델을 한 번에 렌더링하거나 모델을 학습시키기 위한 개별 API를 있습니다.

모델을 렌더링하는 방법:

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 선택 콘텐츠 > SmartDocs Drupal 관리 메뉴로 이동합니다
  3. 렌더링할 모델에서 API 버전을 선택합니다. 연산.
  4. 렌더링할 버전을 선택합니다. 단일 버전의 노드만 렌더링할 수 있습니다. 있습니다.
  5. 렌더링할 방법을 선택합니다.
  6. 업데이트에서 렌더링 노드를 선택합니다. 옵션 드롭다운 메뉴를 클릭합니다.
  7. Update를 클릭합니다.
  8. 로드 화면이 표시되어 렌더링 중인 노드의 진행률을 볼 수 있습니다.
    노드가 렌더링되면 각 API의 Drupal 노드 ID가 모델의 노드 연결 열 노드 연결 열을 확인하여 렌더링된 노드를 확인합니다.

렌더링 노드를 선택하는 대신 렌더링 및 노드를 게시하여 API를 렌더링하고 즉시 Drupal 노드로 게시합니다.

노드 게시

노드는 게시될 때까지 포털 사용자에게 표시되지 않습니다. 원하는 경우 노드를 게시할 수 있습니다 노드를 게시하지 않도록 선택하면 렌더링이 완료된 후에 수동으로 게시해야 합니다.

노드를 게시하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 선택 콘텐츠 > SmartDocs의 영향을 받습니다. Drupal 관리 메뉴로 이동합니다
  3. 게시할 모델의 경우 아래에서 API 버전을 선택합니다. 연산.
  4. 게시할 버전을 선택합니다. 단일 버전의 노드만 게시할 수 있습니다. 모델의 성능을 평가합니다.
  5. 게시 방법을 선택합니다.
  6. 게시할 버전의 노드를 선택하세요.
  7. 업데이트에서 노드 게시를 선택합니다. 옵션 드롭다운 메뉴를 클릭합니다.
  8. Update를 클릭합니다.
  9. 노드 연결에서 노드 ID를 선택하여 노드로 이동합니다. 를 클릭합니다.

기본적으로 게시된 API 노드의 Drupal URL은 http://<drupalBasePath>/<internalName>/apis/<httpMethod>/<resourcePath> 형식입니다. URL 형식을 제어하려면 다음 절차를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 구성 > 검색 및 메타데이터 > URL 별칭 > 패턴을 참고하세요.
  3. 모든 SmartDocs 메서드 경로 경로 패턴에서 경로를 생성합니다.
  4. Save configuration을 선택합니다.

포털에서의 캐싱으로 인해 모델 페이지가 즉시 표시되지 않을 수 있습니다. 확인할 수 있습니다 필요한 경우 다음 절차를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 구성 > Drupal 관리의 SmartDocs 선택합니다.
  3. SmartDocs 모델 캐시 다시 빌드를 클릭합니다.

노드 게시 취소

언제든지 게시된 노드의 게시를 취소할 수 있습니다. 노드를 게시 취소하면 노드가 표시되지 않습니다. 있습니다.

노드를 게시 취소하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 선택 콘텐츠 > SmartDocs의 영향을 받습니다. Drupal 관리 메뉴로 이동합니다
  3. 게시 취소할 모델의 경우 아래에서 API 버전을 선택합니다. 연산.
  4. 게시 취소할 노드의 모델 버전을 선택합니다.
  5. 게시 취소할 버전의 노드를 선택하세요.
  6. 업데이트에서 노드 게시 취소를 선택합니다. 옵션 드롭다운 메뉴를 클릭합니다.
  7. Update를 클릭합니다.

모델의 버전 보기

새 WADL 파일 또는 OpenAPI 사양을 가져와 모델의 새 버전을 만듭니다. 새 버전을 수동으로 만들어 기존 모델로 전환할 수 있습니다. 새 버전을 만든 후에는 버전을 렌더링하고 게시할 수 있으며, 이는 현재 게시된 Drupal 노드를 대체합니다.

여러 버전의 노드를 동시에 렌더링하고 게시할 수 있습니다. 의미: 5개 버전의 모델을 기반으로 하는 경우 일부 또는 모든 버전의 노드를 게시할 수 있습니다. 하지만 한 모델의 API가 다른 모델의 게시된 노드와 동일한 경우 이전 가장 최근에 게시된 API 버전 중 하나로 대체합니다. API에 액세스할 수 있습니다.

모델의 버전을 확인하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 선택 콘텐츠 > Google Workspace의 Drupal 관리 메뉴로 이동합니다
  3. 업데이트할 모델에서 API 버전을 선택합니다. 연산.
  4. 확인할 모델 버전을 선택합니다.
  5. 위에 설명된 대로 노드를 렌더링하고 게시합니다.

노드 수정

노드를 렌더링한 후 Drupal 편집기를 사용하여 수정할 수 있습니다. 예를 들어 HTTP 동사 및 API 설명 또는 새 쿼리 또는 헤더 매개변수를 API에 추가할 수 있습니다. 나 WADL 파일 또는 OpenAPI 사양에서 생성된 노드, 또는 생성한 노드를 작업을 수행할 수 있습니다

원본 WADL 파일 또는 OpenAPI 사양을 수정할 수도 있습니다. 사용을 마치면 WADL 파일 또는 OpenAPI 사양을 모델에 다시 새 버전으로 가져옵니다. 그런 다음 위에 설명된 대로 변경사항을 렌더링하고 게시합니다.

Drupal 편집기를 사용하여 노드를 수정하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 원하는 API 문서에 해당하는 Drupal 노드로 이동합니다. 수정할 수 있습니다
  3. Drupal 편집기를 사용하려면 수정을 선택합니다.
  4. 수정이 완료되면 업데이트 방법을 선택합니다.

또는 SmartDocs 모델에서 노드를 수정할 수 있습니다.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 콘텐츠 >를 선택합니다. Google Workspace의 Drupal 관리 메뉴로 이동합니다
  3. 업데이트할 모델에서 API 버전을 선택합니다. 연산.
  4. 게시할 모델 버전을 선택하세요.
  5. 메서드의 작업 드롭다운에서 메서드 수정을 선택합니다. 선택합니다.

노드를 삭제하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 콘텐츠 >를 선택합니다. Google Workspace의 Drupal 관리 메뉴로 이동합니다
  3. 업데이트할 모델에서 API 버전을 선택합니다. 연산.
  4. 게시할 모델 버전을 선택하세요.
  5. 다음에서 Delete method(방법 삭제)를 선택합니다. Operations 드롭다운만 반환합니다.
    주의: 노드를 삭제하면 모델에서 API도 삭제됩니다. 만약 API를 게시 취소하여 포털 사용자에게 표시되지 않도록 하고 싶지만 삭제하지는 않으려는 경우 위에서 설명한 대로 노드를 게시 취소해야 합니다.

포털에는 기본 제공 보고서가 있는데, 이 보고서에는 SmartDocs 모델은 더 이상 모델의 유효한 메서드를 참조하지 않습니다. 보고서 액세스 기준 Drupal 메뉴에서 보고서를 선택한 다음 보고서를 선택합니다. 이름이 SmartDocs 노드 상태입니다.

모델 내보내기 및 가져오기

SmartDocs를 사용하면 기존 모델을 파일로 내보낼 수 있습니다. 예를 들어 프로덕션 및 스테이징 환경 중에서 선택할 수 있습니다 그런 다음 스테이징 환경에서 SmartDocs를 모두 수정합니다. 환경입니다 API를 출시할 준비가 되면 스테이징 모델을 내보내고 가져옵니다. 적용할 수 있습니다

모델을 가져오면 모델의 새 버전이 생성됩니다. SmartDocs는 기존 가져온 API가 있는 모델의 API SmartDocs에서 일치하는 항목을 감지하면 가져오기로 Drupal이 업데이트됩니다. 기존 API에 해당하는 노드를 찾습니다. SmartDocs에서 일치하는 항목을 감지하지 못하면 가져오기 API를 위한 새 Drupal 노드를 만듭니다.

예를 들어 POST API가 있으며 ID가 91인 Drupal 노드에 해당합니다. 그런 다음 SmartDocs가 모델을 가져오면 SmartDocs가 가져온 모델에서 기존 POST API로 이동합니다. POST API를 업데이트하면 Drupal 노드 91이 업데이트됩니다. SmartDocs가 새로운 ID가 있는 새 Drupal 노드를 만듭니다.

Drupal은 다음과 같은 API 특성을 사용하여 일치를 수행합니다.

  • internalName: 내부 모델 이름입니다.
  • httpMethod: API의 HTTP 메서드(예: GET, PUT, POST 또는 삭제를 탭합니다.
  • resourcePath: 리소스 경로입니다.
  • query params: API에서 사용하는 모든 쿼리 매개변수입니다.

가져온 API의 네 가지 특성이 모두 모델의 기존 API와 일치하면 SmartDocs가 기존 Drupal 노드를 업데이트합니다.

내보낸 모델은 리소스 및 항목에 대한 항목이 있는 단일 JSON 객체로 표현됩니다. 메서드를 참조하세요. 즉, 내보낸 모델을 수정하여 리소스나 메서드를 수정한 다음 모델을 다시 가져옵니다 JSON 객체를 수정하는 경우 다음 필드를 수정하지 마세요.

  • revisionNumber
  • createdTime
  • modifiedTime
  • apiRevisionId
  • resourceId

모델을 내보내려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 선택 콘텐츠 > Google Workspace의 Drupal 관리 메뉴로 이동합니다
  3. 내보낼 모델에서 내보내기를 선택합니다. 작업.
  4. 내보내기 파일 형식을 SmartDocs JSON으로 선택합니다.
  5. 내보내기를 클릭합니다.
  6. 파일을 디스크에 저장하거나 편집기에서 열라는 메시지가 표시됩니다.

모델을 가져오려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 선택 콘텐츠 > Google Workspace의 Drupal 관리 메뉴로 이동합니다
  3. 가져올 모델에서 가져오기를 선택합니다. 작업.
  4. 형식 선택 드롭다운에서 SmartDocs JSON을 선택합니다.
  5. 다음에서 파일 또는 URL을 선택합니다. 업로드 유형: <ph type="x-smartling-placeholder">
      </ph>
    1. 파일을 선택한 경우 JSON 파일을 찾습니다.
    2. URL을 선택하는 경우 SmartDocs JSON 파일의 URL을 지정합니다.
  6. 가져오기를 클릭하여 모델로 가져옵니다.
  7. 이제 모델의 정보 페이지로 리디렉션되어 있습니다. 가져오기를 수행하면 모델의 새 버전이 생성됩니다.
  8. 노드를 렌더링하고 게시합니다.

SmartDocs 템플릿 수정

SmartDocs 템플릿은 Drupal 노드가 화면에 표시되는 방식을 정의합니다. 각 SmartDocs 모델이 동일한 기본 템플릿을 사용하거나 모델에 사용되는 템플릿을 모델을 학습시키는 작업도 반복해야 합니다

SmartDocs 템플릿에는 Handlebars .hbr 파일로 코딩된 템플릿 파일, CSS 파일, 자바스크립트 파일도 지원합니다. 핸들바를 사용하면 콘텐츠의 상당 부분이 &123;&123;body}}와 같은 핸들바 표현식. 기존 핸들바 표현식은 파일 상단의 주석에 제공됩니다. 자세한 내용은 Handlebars를 사용하여 템플릿을 맞춤설정하는 방법에 대한 자세한 내용은 http://handlebarsjs.com을 참조하세요.

다음 섹션에서는 모든 사용자가 사용할 맞춤 SmartDocs 템플릿 파일을 업로드하는 방법을 설명합니다. 새 모델을 가져오는 경우와 기존 모델로 새 API를 가져오는 경우 기본 SmartDocs 템플릿 파일 및 SmartDocs 템플릿을 수정하는 방법 모델을 학습시키는 작업도 반복해야 합니다

맞춤 동영상 업로드 SmartDocs 템플릿 파일

맞춤 SmartDocs 템플릿 파일을 Handlebars .hbr 파일로 업로드하여 기본 템플릿을 사용해야 합니다.

기본 SmartDocs 템플릿 파일을 만들 때 시작점으로 사용하려는 경우 맞춤 SmartDocs 템플릿 파일에서 사본을 다운로드할 수 있습니다. profiles/apigee/modules/custom/devconnect/smartdocs/templates/smartdocs.hbr

맞춤 SmartDocs 템플릿 파일을 업로드하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 구성 > Drupal의 SmartDocs 관리 메뉴
  3. 페이지의 고급 설정 영역을 펼칩니다.
  4. '맞춤설정된 메서드 템플릿 업로드'에서 파일 선택을 클릭합니다. Handlebars .hbr 파일로 이동합니다.
  5. 업로드를 클릭합니다.
  6. 구성 저장을 클릭합니다.

서비스 계정을 기본 SmartDocs 템플릿 파일

기본 SmartDocs 템플릿 파일을 복원할 수 있습니다. 복원하면 기본 SmartDocs 템플릿 파일은 새 모델을 만들거나 새 API를 기존 모델로 가져올 때 사용됩니다. 있습니다.

기본 SmartDocs 템플릿 파일을 복원하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 구성 > Drupal의 SmartDocs 관리 메뉴
  3. 페이지의 고급 설정 영역을 펼칩니다.
  4. '맞춤 메서드 템플릿 업로드'에서 커스텀 SmartDocs 템플릿 파일을 생성합니다.
  5. 구성 저장을 클릭합니다.

수정 중 개별 모델을 위한 SmartDocs 템플릿

개별 모델에 사용되는 템플릿을 수정할 수 있습니다.

개인 모델의 템플릿을 수정하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 선택 콘텐츠 > Google Workspace의 Drupal 관리 메뉴로 이동합니다
  3. 수정할 모델에서 설정을 선택합니다. 작업.
  4. 메서드 템플릿 영역에서 템플릿을 필요에 따라 수정합니다.
  5. 템플릿 저장을 클릭합니다.
  6. Drupal 노드를 찾습니다. 페이지에 템플릿 변경사항이 표시됩니다.

SmartDocs 인증 유형

SmartDocs에 정의된 API는 개방될 수 있습니다. 즉, 사용자 인증 정보가 보호하거나 보호할 수 없습니다. 보안 API를 사용하려면 API를 생성할 때 API 호출

SmartDocs는 안전한 API를 위해 다음 유형의 인증을 지원합니다.

  • 기본 인증 - 기본 사용자 인증 정보를 사용자 이름과 비밀번호의 쌍입니다. OAuth를 사용자 인증 정보 유형으로 사용하도록 지정하지 않으면 API 기본적으로 기본 인증이 사용됩니다.
  • OAuth 2.0 - 서드 파티 서비스 제공업체에서 사용자에게 API에 대한 권한이 있는지 확인한 후 액세스 권한을 발급합니다. 토큰입니다. 보호되는 API에 SmartDocs 요청을 보내면 SmartDocs가 요청을 빌드하고 서비스 제공업체에 전송합니다. 그런 다음 서비스 제공업체는 토큰을 검증하고 만료되지 않았음을 확인할 수 있습니다.
  • 맞춤 토큰: 토큰 값을 헤더 또는 쿼리 매개변수로 합니다.

각 인증 유형에 대해 다음을 정의하는 보안 스키마를 만듭니다. 특성에 따라 다릅니다 예를 들어 커스텀 토큰 인증의 경우 보안 스키마는 토큰이 전달되는 방법 (header, query param, body param)과 반환합니다.

보안 스키마는 모델의 특정 버전과 관련되어 있습니다. 따라서 모델의 새 버전이 있으면 해당 버전에 대한 보안 스키마를 재정의해야 합니다.

WADL 파일에서 다음과 같이 &lt;apigee:authentication&gt; Apigee 태그를 사용하여 API에 인증이 필요한지 여부를 지정합니다. 다음과 같습니다.

<method id="statusespublic_timeline" name="GET" apigee:displayName="PublicTimeline">
    ...
    <apigee:authentication required="true"/>
</method>

API가 열려 있으면 required 속성을 false로 설정합니다.

WADL 파일에는 인증 유형을 지정할 수 없습니다. 그렇게 하려면 Drupal에서 노드를 수정할 수 있습니다 WADL 파일에 대한 자세한 내용은 WADL을 참고하세요. 참조.

Drupal의 API 페이지에서 SmartDocs는 다음 버튼을 추가하여 사용자가 기본 사용자 인증 정보:

인증 유형을 OAuth로 설정하도록 노드를 수정하면 SmartDocs가 버튼을 추가합니다.

커스텀 토큰의 경우 SmartDocs는 다음을 추가합니다.

구성 기본 인증

API에서 기본 인증을 사용하는 경우 WADL에 &lt;apigee:authentication&gt; 태그만 지정하면 됩니다. 파일을 만듭니다.

WADL 파일이 아닌 소스에서 생성된 메서드에 기본 인증을 적용하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 콘텐츠 > 를 선택합니다. 스마트한 Drupal 관리 메뉴로 이동합니다
  3. 원하는 모델에서 API 버전을 선택합니다. 연산.
  4. 수정할 모델 버전에서 보안을 선택합니다. 설정의 작업 아래에 있습니다.
  5. 보안 스키마 추가를 선택합니다.
  6. 보안 스키마의 이름을 지정합니다.
  7. 유형으로 기본을 선택합니다.
  8. 제출을 선택합니다.
  9. 모델의 각 메서드에 대해 메서드를 수정하여 보안 스키마를 설정합니다. 기본 스키마에 추가합니다.
    1. 콘텐츠 > 를 선택합니다. 스마트한 Drupal 관리 메뉴로 이동합니다
    2. 원하는 모델에서 API 버전을 선택합니다. 연산.
    3. 수정할 모델 버전에서 버전을 선택합니다. 세부정보를 보려면 작업 아래에 있습니다.
    4. 수정할 API에서 메서드 수정을 선택합니다.
    5. API의 보안 스키마를 선택합니다.
    6. API를 저장합니다.

구성 OAuth 2.0 인증

SmartDocs에서 기본의 기본값 대신 OAuth 2.0을 사용하도록 모델을 구성할 수 있습니다. 있습니다. OAuth는 다음 두 위치에서 구성합니다.

  1. 보안에서 모델의 각 버전에 대한 보안 스키마를 만듭니다. 설정을 선택합니다.
  2. 모델의 모든 버전에 대한 클라이언트 ID 및 클라이언트 보안 비밀번호를 지정합니다. 모델의 설정입니다.
를 통해 개인정보처리방침을 정의할 수 있습니다.

OAuth를 사용 설정하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 콘텐츠 > 를 선택합니다. 스마트한 Drupal 관리 메뉴로 이동합니다
  3. 원하는 모델의 '작업'에서 API 버전을 선택합니다.
  4. 수정할 모델 버전의 경우 아래에서 보안 설정을 선택합니다. 작업.
  5. 보안 스키마 추가를 선택합니다.
  6. 보안 스키마의 이름을 지정합니다.
  7. 유형으로 OAuth 2.0을 선택합니다.
  8. 부여 유형을 설정합니다.
  9. 승인 URL 입력란에 값을 입력합니다. 승인 URL은 액세스 토큰을 얻는 데 사용됩니다.
  10. 승인 동사를 GET 또는 POST로 설정합니다.
  11. 액세스 토큰 URL을 입력합니다. 액세스 토큰 URL은 요청 토큰을 액세스 토큰으로 교환합니다.
  12. 액세스 토큰 매개변수 이름을 입력합니다.
  13. In을 사용하여 토큰을 전달하는 방법을 지정합니다. Header, 쿼리 또는 본문입니다.
  14. OAuth 범위를 설정합니다.
  15. 제출을 선택합니다.
  16. 콘텐츠 > 를 선택합니다. 스마트한 Drupal 관리 메뉴로 이동합니다
  17. 모델의 경우 작업에서 설정을 선택합니다. 드롭다운 메뉴에서 선택합니다.
  18. 클라이언트 ID 및 클라이언트에 값을 입력합니다. Secret.
  19. 템플릿 인증 설정 저장을 선택합니다.
  20. 모델의 각 메서드에 대해 메서드를 수정하여 보안 스키마를 설정합니다. 추가해야 합니다
    1. 콘텐츠 > 를 선택합니다. 스마트한 Drupal 관리 메뉴로 이동합니다
    2. 원하는 모델에서 API 버전을 선택합니다. 연산.
    3. 수정할 모델 버전에서 버전을 선택합니다. 세부정보를 보려면 작업 아래에 있습니다.
    4. 수정할 API에서 메서드 수정을 선택합니다.
    5. API의 보안 스키마를 선택합니다.
    6. API를 저장합니다.

커스텀 토큰 인증 구성

커스텀 토큰 인증을 사용하도록 모델을 구성할 수 있습니다.

커스텀 토큰을 사용 설정하려면 다음 안내를 따르세요.

  1. 관리자 또는 콘텐츠 생성 권한이 있는 사용자로 포털에 로그인합니다.
  2. 콘텐츠 > 를 선택합니다. 스마트한 Drupal 관리 메뉴로 이동합니다
  3. 원하는 모델에서 API 버전을 선택합니다. 연산.
  4. 수정할 모델 버전에서 보안을 선택합니다. 설정의 작업 아래에 있습니다.
  5. 보안 스키마 추가를 선택합니다.
  6. 보안 스키마의 이름을 지정합니다.
  7. 유형으로 Apikey를 선택합니다.
  8. 토큰이 포함된 Param Name을 설정합니다.
  9. In을 사용하여 토큰: Header, Query, 또는 본문일 수 있습니다.
  10. 제출을 선택합니다.
  11. 모델의 각 메서드에 대해 메서드를 수정하여 보안 스키마를 설정합니다. 토큰 스키마에 추가합니다
    1. 콘텐츠 > 를 선택합니다. 스마트한 Drupal 관리 메뉴로 이동합니다
    2. 원하는 모델에서 API 버전을 선택합니다. 연산.
    3. 수정할 모델 버전에서 버전을 선택합니다. 세부정보를 보려면 작업 아래에 있습니다.
    4. 수정할 API에서 메서드 수정을 선택합니다.
    5. API의 보안 스키마를 선택합니다.
    6. API를 저장합니다.

모델 삭제

모델을 삭제하면 (콘텐츠 > SmartDocs, 삭제 Drupal의 작업 필드를 사용 중지)하면 Edge 조직에서 모델이 삭제됩니다. 즉, 다른 포털에서 모델을 참조하면 모델을 더 이상 사용할 수 없습니다. 자세한 내용은 SmartDoc 모델 및 템플릿 정보를 참조하세요.