Mảng chú thích PHP của các đối tượng

Các thuộc tính bổ sung, Thành phần, Liên hệ, Xóa, Phân biệt đối xử, Ví dụ, Tài liệu bên ngoài, Luồng, Nhận, Phần đầu, Tiêu đề, Thông tin, Mục, JsonContent, Giấy phép, Liên kết, Loại phương tiện, OpenApi, Hoạt động, Tùy chọn, Tham số, Bản vá, Mục đường dẫn, Tham số đường dẫn, Bài đăng,

Giữ một tập hợp các đối tượng có thể tái sử dụng cho các khía cạnh khác nhau của OA

Tất cả các đối tượng được xác định trong đối tượng thành phần sẽ không có tác dụng đối với API trừ khi chúng được tham chiếu rõ ràng từ các thuộc tính bên ngoài đối tượng thành phần

được phép trong

---

MởApi

các phần tử lồng nhau

---

Phản hồi, Tham số, Tham số đường dẫn, RequestBody, Ví dụ, Tiêu đề, SecurityScheme, Liên kết, Lược đồ, Có thể đính kèm

Của cải

---

gọi lại. mảng

Gọi lại có thể tái sử dụng

Thẩm quyền giải quyết

---

Thông tin liên hệ cho API bị lộ

được phép trong

---

Thông tin

các phần tử lồng nhau

---

Có thể đính kèm

Của cải

---

Tên. chuỗi

Tên nhận dạng của người/tổ chức liên hệ

url. chuỗi

URL trỏ đến thông tin liên hệ

e-mail. chuỗi

Địa chỉ email của người/tổ chức liên hệ

Thẩm quyền giải quyết

---

Thông số cookie @OA\Request

được phép trong

---

Thành phần, PathItem, Thao tác, Nhận, Đăng, Đặt, Xóa, Vá, Phần đầu, Tùy chọn, Theo dõi

các phần tử lồng nhau

---

Lược đồ, Ví dụ, Có thể đính kèm

Của cải

---

Trong

Không có thông tin chi tiết

được phép trong

---

Mục đường dẫn

các phần tử lồng nhau

---

Tham số, Tham số đường dẫn, Phản hồi, Tài liệu bên ngoài, Máy chủ, RequestBody, Có thể đính kèm

Của cải

---

phương pháp

Không có thông tin chi tiết

Bộ phân biệt đối xử là một đối tượng cụ thể trong một lược đồ được sử dụng để thông báo cho người tiêu dùng về đặc điểm kỹ thuật của một lược đồ thay thế dựa trên giá trị được liên kết với nó

Đối tượng này dựa trên Đặc tả lược đồ JSON và sử dụng một tập hợp con được xác định trước của nó. Ngoài tập hợp con này, có các phần mở rộng được cung cấp bởi thông số kỹ thuật này để cho phép tài liệu đầy đủ hơn

được phép trong

---

Lược đồ, Thuộc tính, Thuộc tính bổ sung, Mục, JsonContent, XmlContent

các phần tử lồng nhau

---

Có thể đính kèm

Của cải

---

tên tài sản. chuỗi

Tên của thuộc tính trong tải trọng sẽ giữ giá trị phân biệt đối xử

lập bản đồ. chuỗi[]

Một đối tượng để giữ ánh xạ giữa các giá trị tải trọng và tên lược đồ hoặc tham chiếu

Thẩm quyền giải quyết

---

được phép trong

---

Thành phần, Tham số, Tham số đường dẫn, Loại phương tiện, JsonContent, XmlContent

các phần tử lồng nhau

---

Có thể đính kèm

Của cải

---

giới thiệu. chuỗi. mục tiêu

Không có thông tin chi tiết

Thấy. Sử dụng giới thiệu

thí dụ. chuỗi

Nhập khóa vào `#/components/examples`

tóm lược. chuỗi

Mô tả ngắn cho ví dụ

sự miêu tả. chuỗi

Ví dụ về nghĩa đen được nhúng

Trường giá trị và trường giá trị bên ngoài là loại trừ lẫn nhau

Để trình bày các ví dụ về loại phương tiện không thể trình bày một cách tự nhiên
trong JSON hoặc YAML, hãy sử dụng một giá trị chuỗi để chứa ví dụ, thoát khi cần thiết.

giá trị. int. chuỗi. mảng

Ví dụ về nghĩa đen được nhúng

Trường giá trị và trường giá trị bên ngoài là loại trừ lẫn nhau

Để trình bày các ví dụ về loại phương tiện không thể trình bày một cách tự nhiên
trong JSON hoặc YAML, hãy sử dụng một giá trị chuỗi để chứa ví dụ, thoát khi cần thiết.

giá trị bên ngoài. chuỗi

Một URL trỏ đến ví dụ theo nghĩa đen

Điều này cung cấp khả năng tham khảo các ví dụ không thể dễ dàng đưa vào
trong tài liệu JSON hoặc YAML.

Trường giá trị và trường giá trị bên ngoài là loại trừ lẫn nhau

Cho phép tham chiếu một tài nguyên bên ngoài cho tài liệu mở rộng

được phép trong

---

OpenApi, Thẻ, Lược đồ, Thuộc tính bổ sung, Thuộc tính, Hoạt động, Nhận, Đăng, Đặt, Xóa, Vá, Phần đầu, Tùy chọn, Theo dõi, Mục, JsonContent, XmlContent

các phần tử lồng nhau

---

Có thể đính kèm

Của cải

---

sự miêu tả. chuỗi

Mô tả ngắn về tài liệu đích. Cú pháp GFM có thể được sử dụng để biểu diễn văn bản có định dạng

url. chuỗi

URL cho tài liệu đích

Thẩm quyền giải quyết

---

Chi tiết cấu hình cho Luồng OAuth được hỗ trợ

được phép trong

---

Đề án bảo mật

các phần tử lồng nhau

---

Có thể đính kèm

Của cải

---

ủy quyềnUrl. chuỗi

Url ủy quyền sẽ được sử dụng cho quy trình này

Điều này phải ở dạng url

url mã thông báo. chuỗi

URL mã thông báo sẽ được sử dụng cho quy trình này

Điều này phải ở dạng url

refreshUrl. chuỗi

URL được sử dụng để lấy mã thông báo làm mới

Điều này phải ở dạng url

lưu lượng. chuỗi

tên luồng

Một trong ['ẩn', 'mật khẩu', 'Mã ủy quyền', 'clientCredentials']

phạm vi. mảng

Các phạm vi khả dụng cho sơ đồ bảo mật OAuth2

Một bản đồ giữa tên phạm vi và một mô tả ngắn cho nó

Thẩm quyền giải quyết

---

được phép trong

---

Mục đường dẫn

các phần tử lồng nhau

---

Tham số, Tham số đường dẫn, Phản hồi, Tài liệu bên ngoài, Máy chủ, RequestBody, Có thể đính kèm

Của cải

---

phương pháp

Không có thông tin chi tiết

được phép trong

---

Mục đường dẫn

các phần tử lồng nhau

---

Tham số, Tham số đường dẫn, Phản hồi, Tài liệu bên ngoài, Máy chủ, RequestBody, Có thể đính kèm

Của cải

---

phương pháp

Không có thông tin chi tiết

được phép trong

---

Thành phần, Phản hồi

các phần tử lồng nhau

---

Lược đồ, có thể đính kèm

Của cải

---

giới thiệu. chuỗi. mục tiêu

Không có thông tin chi tiết

Thấy. Sử dụng giới thiệu

tiêu đề. chuỗi

Không có thông tin chi tiết

sự miêu tả. chuỗi

Mô tả ngắn gọn về tham số

Điều này có thể chứa các ví dụ sử dụng.
Cú pháp CommonMark CÓ THỂ được sử dụng để biểu diễn văn bản có định dạng.

yêu cầu. bool

Không có thông tin chi tiết

không dùng nữa. bool

Chỉ định rằng một tham số không được dùng nữa và NÊN được chuyển đổi khỏi sử dụng

allowEmptyValue. bool

Đặt khả năng chuyển các tham số có giá trị trống

Điều này chỉ hợp lệ cho các tham số truy vấn và cho phép gửi tham số có giá trị trống

Giá trị mặc định là sai

Nếu phong cách được sử dụng và nếu hành vi là n/a (không thể được tuần tự hóa), giá trị của allowEmptyValue SẼ bị bỏ qua

Thẩm quyền giải quyết

---

Tham số tiêu đề @OA\Request

được phép trong

---

Thành phần, PathItem, Thao tác, Nhận, Đăng, Đặt, Xóa, Vá, Phần đầu, Tùy chọn, Theo dõi

các phần tử lồng nhau

---

Lược đồ, Ví dụ, Có thể đính kèm

Của cải

---

Trong

Không có thông tin chi tiết

Đối tượng cung cấp siêu dữ liệu về API

Siêu dữ liệu có thể được khách hàng sử dụng nếu cần và có thể được trình bày trong các công cụ chỉnh sửa hoặc tạo tài liệu để thuận tiện

được phép trong

---

MởApi

các phần tử lồng nhau

---

Liên hệ, Giấy phép, Có thể đính kèm

Của cải

---

chức vụ. chuỗi

Tiêu đề của ứng dụng

sự miêu tả. chuỗi

Mô tả ngắn về ứng dụng

Cú pháp CommonMark có thể được sử dụng để biểu diễn văn bản có định dạng

điều khoản dịch vụ. chuỗi

URL tới Điều khoản dịch vụ cho API

Phải ở định dạng url

phiên bản. chuỗi

Phiên bản của tài liệu OpenAPI (khác với phiên bản Đặc tả OpenAPI hoặc phiên bản triển khai API)

Thẩm quyền giải quyết

---

Mô tả của một mục trong Schema với loại array

được phép trong

---

Thuộc tính, Thuộc tính bổ sung, Lược đồ, JsonContent, XmlContent, Mục

các phần tử lồng nhau

---

Người phân biệt đối xử, Mục, Thuộc tính, Tài liệu bên ngoài, Xml, Thuộc tính bổ sung, Ví dụ, Có thể đính kèm