OpenAPI 3.0 사양에 정의된 함수 선언의 구조화된 표현 이 선언에는 함수 이름과 매개변수가 포함됩니다. 이 FunctionDeclaration
는 모델에서 도구로 사용하고 클라이언트에서 실행할 수 있는 코드 블록을 나타냅니다.
서명:
export declare interface FunctionDeclaration
속성
속성 | 유형 | 설명 |
---|---|---|
description | 문자열 | 선택사항입니다. 함수 설명 및 용도입니다. 모델은 이를 사용하여 함수 호출 방법과 호출 여부를 결정합니다. |
name | 문자열 | 호출하려는 함수의 이름입니다. 문자 또는 밑줄로 시작해야 하며 a~z, A~Z, 0~9이거나 밑줄과 대시를 포함해야 하며 최대 길이는 64자(영문 기준)입니다. |
매개변수 | FunctionDeclarationSchema | 선택사항입니다. 이 함수의 매개변수를 JSON 스키마 객체 형식으로 설명합니다. Open API 3.03 매개변수 객체를 반영합니다. 매개변수 이름은 대소문자를 구분합니다. 매개변수가 없는 함수의 경우 설정하지 않은 상태로 둘 수 있습니다. |
FunctionDeclaration.description
선택사항입니다. 함수 설명 및 용도입니다. 모델은 이를 사용하여 함수 호출 방법과 호출 여부를 결정합니다.
서명:
description?: string;
함수 선언.이름
호출하려는 함수의 이름입니다. 문자 또는 밑줄로 시작해야 하며 a~z, A~Z, 0~9이거나 밑줄과 대시를 포함해야 하며 최대 길이는 64자(영문 기준)입니다.
서명:
name: string;
FunctionDeclaration.parameters
선택사항입니다. 이 함수의 매개변수를 JSON 스키마 객체 형식으로 설명합니다. Open API 3.03 매개변수 객체를 반영합니다. 매개변수 이름은 대소문자를 구분합니다. 매개변수가 없는 함수의 경우 설정하지 않은 상태로 둘 수 있습니다.
서명:
parameters?: FunctionDeclarationSchema;