Giản đồ dùng để xác định định dạng của dữ liệu đầu vào/đầu ra. Đại diện cho một tập hợp con chọn lọc của đối tượng giản đồ OpenAPI 3.0. Trong tương lai, chúng tôi có thể thêm các trường khác nếu cần.
Chữ ký:
export interface FunctionDeclarationSchemaProperty
Thuộc tính
| Tài sản | Loại | Mô tả |
|---|---|---|
| description [mô_tả] | chuỗi | Không bắt buộc. Nội dung mô tả về cơ sở lưu trú. |
| enum | chuỗi[] | Không bắt buộc. Enum của thuộc tính. |
| ví dụ | không xác định | Không bắt buộc. Ví dụ về cơ sở lưu trú. |
| định dạng | chuỗi | Không bắt buộc. Định dạng của thuộc tính. |
| items | FunctionKhailarationSchema | Không bắt buộc. Các mục của cơ sở lưu trú. FunctionKhailarationSchema |
| có thể nhận giá trị rỗng | boolean | Không bắt buộc. Liệu thuộc tính có thể có giá trị rỗng hay không. |
| tài sản | { [k: string]: FunctionDeclarationSchema; } | Không bắt buộc. Bản đồ của FunctionDeclarationSchema. |
| bắt buộc | chuỗi[] | Không bắt buộc. Mảng gồm các thuộc tính bắt buộc. |
| loại | FunctionDeclarationSchemaType | Không bắt buộc. Loại cơ sở lưu trú. FunctionDeclarationSchemaType. |
FunctionDeclarationSchemaProperty.description
Không bắt buộc. Nội dung mô tả về cơ sở lưu trú.
Chữ ký:
description?: string;
FunctionKhailarationSchemaProperty.enum
Không bắt buộc. Enum của thuộc tính.
Chữ ký:
enum?: string[];
FunctionDeclarationSchemaProperty.example
Không bắt buộc. Ví dụ về cơ sở lưu trú.
Chữ ký:
example?: unknown;
FunctiondeclarationSchemaProperty.format
Không bắt buộc. Định dạng của thuộc tính.
Chữ ký:
format?: string;
FunctionKhailarationSchemaProperty.items
Không bắt buộc. Các mục của cơ sở lưu trú. FunctionKhailarationSchema
Chữ ký:
items?: FunctionDeclarationSchema;
FunctiondeclarationSchemaProperty.có
Không bắt buộc. Liệu thuộc tính có thể có giá trị rỗng hay không.
Chữ ký:
nullable?: boolean;
FunctionDeclarationSchemaProperty.properties
Không bắt buộc. Bản đồ của FunctionDeclarationSchema.
Chữ ký:
properties?: {
[k: string]: FunctionDeclarationSchema;
};
FunctionDeclarationSchemaProperty.required
Không bắt buộc. Mảng gồm các thuộc tính bắt buộc.
Chữ ký:
required?: string[];
FunctionDeclarationSchemaProperty.type
Không bắt buộc. Loại cơ sở lưu trú. FunctionDeclarationSchemaType.
Chữ ký:
type?: FunctionDeclarationSchemaType;