Nội dung trình bày có cấu trúc của phần khai báo hàm theo xác định trong quy cách OpenAPI 3.0. Nội dung khai báo này có tên hàm và các tham số. FunctionDeclaration này là đại diện của một khối mã mà mô hình có thể sử dụng làm Công cụ và được ứng dụng thực thi.
Chữ ký:
export declare interface FunctionDeclaration
Thuộc tính
| Tài sản | Loại | Mô tả |
|---|---|---|
| description [mô_tả] | chuỗi | Không bắt buộc. Mô tả và mục đích của hàm. Mô hình sử dụng hàm này để quyết định cách thức và liệu có nên gọi hàm này hay không. |
| name | chuỗi | Tên của hàm cần gọi. Phải bắt đầu bằng một chữ cái hoặc dấu gạch dưới. Phải là các ký tự a-z, A-Z, 0-9 hoặc chứa dấu gạch dưới và dấu gạch ngang, với độ dài tối đa là 64. |
| tham số | FunctionDeclarationSchema | Không bắt buộc. Mô tả các tham số cho hàm này ở định dạng Đối tượng giản đồ JSON. Phản ánh Đối tượng tham số Open API 3.03. Tên thông số có phân biệt chữ hoa chữ thường. Đối với hàm không có tham số, bạn không thể đặt chính sách này. |
FunctionDeclaration.description
Không bắt buộc. Mô tả và mục đích của hàm. Mô hình sử dụng hàm này để quyết định cách thức và liệu có nên gọi hàm này hay không.
Chữ ký:
description?: string;
FunctionDeclaration.name
Tên của hàm cần gọi. Phải bắt đầu bằng một chữ cái hoặc dấu gạch dưới. Phải là các ký tự a-z, A-Z, 0-9 hoặc chứa dấu gạch dưới và dấu gạch ngang, với độ dài tối đa là 64.
Chữ ký:
name: string;
FunctionDeclaration.parameters
Không bắt buộc. Mô tả các tham số cho hàm này ở định dạng Đối tượng giản đồ JSON. Phản ánh Đối tượng tham số Open API 3.03. Tên thông số có phân biệt chữ hoa chữ thường. Đối với hàm không có tham số, bạn không thể đặt chính sách này.
Chữ ký:
parameters?: FunctionDeclarationSchema;