Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. info

Giới thiệu về chính sách OASValidation
Chính sách OASValidation (Xác thực theo quy cách OpenAPI) cho phép bạn xác thực một thông báo yêu cầu hoặc phản hồi đến dựa trên Quy cách OpenAPI 3.0 (JSON hoặc YAML). Xem Nội dung nào được xác thực?
Chính sách OASValidation chỉ định tên của OpenAPI Specification dùng để xác thực khi bước mà chính sách được đính kèm thực thi.
OpenAPI Specification được lưu trữ dưới dạng tài nguyên ở vị trí tiêu chuẩn sau đây trong gói proxy API: apiproxy/resources/oas
.
Quy cách OpenAPI phải có tiện ích .json
, .yml
, .yaml
.
Thêm một OpenAPI Specification làm tài nguyên vào gói proxy API bằng giao diện người dùng hoặc API, như mô tả trong phần Quản lý tài nguyên.
Nội dung nào được xác thực?
Bảng sau đây tóm tắt nội dung thông báo yêu cầu được xác thực theo chính sách OASValidation, theo thành phần.
Thành phần | Yêu cầu xác thực |
---|---|
Basepath | Xác thực đường dẫn cơ sở do API proxy xác định; bỏ qua đường dẫn cơ sở được chỉ định trong Quy cách OpenAPI. |
Đường dẫn | Xác thực rằng đường dẫn yêu cầu (trừ basepath) khớp với một trong các mẫu đường dẫn được xác định trong OpenAPI Specification. |
Động từ | Xác thực rằng động từ được xác định cho đường dẫn trong Thông số kỹ thuật OpenAPI. |
Nội dung thư yêu cầu |
Lưu ý: Chính sách này chỉ xác thực nội dung thông báo yêu cầu theo OpenAPI Specification nếu Content-Type được đặt thành |
Thông số |
|
Bảng sau đây tóm tắt nội dung thông báo phản hồi được xác thực theo chính sách OASValidation, theo thành phần.
Thành phần | Xác thực phản hồi |
---|---|
Đường dẫn | Xác thực rằng đường dẫn yêu cầu (trừ basepath) khớp với một trong các mẫu đường dẫn được xác định trong OpenAPI Specification. |
Động từ | Xác thực rằng động từ được xác định cho đường dẫn trong Thông số kỹ thuật OpenAPI. |
Nội dung thông báo phản hồi |
|
Mẫu
Các ví dụ sau đây minh hoạ một số cách bạn có thể sử dụng chính sách OASValidation để xác thực thông báo dựa trên một Thông số kỹ thuật OpenAPI 3.0.
Trong ví dụ sau đây, chính sách myoaspolicy
xác thực nội dung của thông báo yêu cầu dựa vào giản đồ nội dung thông báo yêu cầu của thao tác được xác định trong Thông số kỹ thuật OpenAPI my-spec.json
.
<OASValidation name="myoaspolicy"> <OASResource>oas://my-spec.json</OASResource> <Options> <ValidateMessageBody>true</ValidateMessageBody> </Options> <Source>request</Source> </OASValidation>
Nếu nội dung thư không tuân thủ Quy cách OpenAPI, thì lỗi policies.oasvalidation.Failed
sẽ được trả về.
Ví dụ sau đây định cấu hình chính sách để không thành công nếu một tham số tiêu đề, truy vấn hoặc cookie được chỉ định trong yêu cầu không được xác định trong Đặc tả OpenAPI.
<OASValidation name="myoaspolicy"> <OASResource>oas://my-spec.yaml</OASResource> <Options> <AllowUnspecifiedParameters> <Header>false</Header> <Query>false</Query> <Cookie>false</Cookie> </AllowUnspecifiedParameters> </Options> </OASValidation>
Phần tử <OASValidation>
Xác định chính sách Xác thực theo quy cách OpenAPI.
Giá trị mặc định | Xem thẻ Chính sách mặc định bên dưới |
Bắt buộc? | Bắt buộc |
Loại | Đối tượng phức tạp |
Phần tử mẹ | Không có |
Phần tử con |
<DisplayName> <OASResource> <Source> <Options> <Source> |
Phần tử <OASValidation>
sử dụng cú pháp sau:
<OASValidation continueOnError="[true|false]" enabled="[true|false]" name="policy_name " > <!-- All OASValidation child elements are optional except OASResource --> <DisplayName>policy_display_name </DisplayName> <OASResource>validation_JSON_or_YAML </OASResource> <Options> <ValidateMessageBody>[true|false]</ValidateMessageBody> <AllowUnspecifiedParameters> <Header>[true|false]</Header> <Query>[true|false]</Query> <Cookie>[true|false]</Cookie> </AllowUnspecifiedParameters> </Options> <Source>message_to_validate </Source> </OASValidation>
Ví dụ sau đây cho thấy các chế độ cài đặt mặc định khi bạn thêm chính sách Xác thực OAS vào quy trình của mình trong giao diện người dùng Apigee:
<OASValidation continueOnError="false" enabled="true" name="OpenAPI-Spec-Validation-1"> <DisplayName>OpenAPI Spec Validation-1</DisplayName> <Properties/> <Source>request</Source> <OASResource>oas://OpenAPI-Spec-Validation-1.yaml</OASResource> </OASValidation>
Phần tử này có các thuộc tính chung cho tất cả các chính sách:
Thuộc tính | Mặc định | Bắt buộc? | Nội dung mô tả |
---|---|---|---|
name |
Không áp dụng | Bắt buộc |
Tên nội bộ của chính sách. Giá trị của thuộc tính Nếu muốn, hãy sử dụng phần tử |
continueOnError |
sai | Không bắt buộc | Đặt thành "false" để trả về lỗi khi một chính sách không thành công. Đây là hành vi dự kiến đối với hầu hết các chính sách. Đặt thành "true" để tiếp tục thực thi luồng ngay cả sau khi chính sách không hoạt động. |
enabled |
true | Không bắt buộc | Đặt thành "true" để thực thi chính sách này. Đặt thành "false" để "tắt" chính sách này. Chính sách sẽ không được thực thi ngay cả khi vẫn được liên kết với một luồng. |
async |
sai | Không được dùng nữa | Thuộc tính này không còn được dùng nữa. |
Tài liệu tham khảo về phần tử con
Phần này mô tả các phần tử con của <OASValidation>
.
<DisplayName>
Sử dụng cùng với thuộc tính name
để gắn nhãn chính sách trong trình chỉnh sửa proxy giao diện người dùng quản lý bằng một tên khác nghe tự nhiên hơn.
Phần tử <DisplayName>
là phần tử chung cho tất cả các chính sách.
Giá trị mặc định | Không có |
Bắt buộc? | Không bắt buộc. Nếu bạn bỏ qua <DisplayName> , giá trị của thuộc tính name trong chính sách sẽ được sử dụng |
Loại | Chuỗi |
Phần tử mẹ | <PolicyElement> |
Phần tử con | Không có |
Phần tử <DisplayName>
sử dụng cú pháp sau:
<PolicyElement> <DisplayName>policy_display_name </DisplayName> ... </PolicyElement>
<PolicyElement> <DisplayName>My Validation Policy</DisplayName> </PolicyElement>
Phần tử <DisplayName>
không có thuộc tính hoặc phần tử con.
<OASResource>
Chỉ định Quy cách OpenAPI để xác thực. Bạn có thể lưu trữ tệp này:
- Tại phạm vi proxy API trong
/apiproxy/resources/oas
trong gói proxy API - Trong phần
Resources
của chế độ xem Trình điều hướng của trình chỉnh sửa proxy API.
Để biết thêm thông tin, hãy xem phần Quản lý tài nguyên.
Bạn có thể chỉ định Đặc tả OpenAPI bằng một mẫu thông báo, chẳng hạn như {oas.resource.url}
.
Trong trường hợp này, giá trị của biến luồng oas.resource.url
(trong dấu ngoặc nhọn) sẽ được đánh giá và thay thế vào chuỗi tải trọng trong thời gian chạy.
Để biết thêm thông tin, hãy xem phần Mẫu tin nhắn.
Giá trị mặc định | Không có |
Bắt buộc? | Bắt buộc |
Loại | Chuỗi |
Phần tử mẹ |
<OASValidation>
|
Phần tử con | Không có |
Phần tử <OASResource>
sử dụng cú pháp sau:
<OASValidation name="policy_name "> <OASResource>oas://specname [.json|.yaml|.yml]</OASResource> ... </OASValidation>
Ví dụ sau đây tham chiếu đến quy cách my-spec.yaml
được lưu trữ trong /apiproxy/resources/oas
trong gói proxy API:
<OASValidation name="myoaspolicy"> <OASResource>oas://my-spec.yaml</OASResource> </OASValidation>
Phần tử <OASResource>
không có thuộc tính hoặc phần tử con.
<Options> (Tuỳ chọn)
Định cấu hình các tuỳ chọn cho chính sách.
Giá trị mặc định | Không có |
Bắt buộc? | Không bắt buộc |
Loại | Loại phức tạp |
Phần tử mẹ |
<OASValidation>
|
Phần tử con |
<ValidateMessageBody> <AllowUnspecifiedParameters> |
Phần tử <Options>
sử dụng cú pháp sau:
<OASValidation name="policy_name "> <OASResource>oas://specname [.json|.yaml|.yml]</OASResource> <Options> <ValidateMessageBody>[true|false]</ValidateMessageBody> <AllowUnspecifiedParameters> <Header>[true|false]</Header> <Query>[true|false]</Query> <Cookie>[true|false]</Cookie> </AllowUnspecifiedParameters> </Options> ... </OASValidation>
Ví dụ sau đây định cấu hình các lựa chọn cho chính sách. Mỗi lựa chọn được mô tả chi tiết hơn ở bên dưới.
<OASValidation name="myoaspolicy"> <OASResource>oas://my-spec.yaml</OASResource> <Options> <ValidateMessageBody>false</ValidateMessageBody> <AllowUnspecifiedParameters> <Header>false</Header> <Query>false</Query> <Cookie>false</Cookie> </AllowUnspecifiedParameters> </Options> </OASValidation>
<ValidateMessageBody>
Chỉ định xem chính sách có nên xác thực nội dung thông báo dựa trên giản đồ nội dung yêu cầu của thao tác trong Đặc tả OpenAPI hay không. Đặt thành true để xác thực nội dung của phần nội dung thư. Đặt thành false để chỉ xác thực rằng phần nội dung thư tồn tại.
Bạn có thể kiểm soát việc thực thi luồng có tiếp tục sau lỗi xác thực hay không bằng cách đặt thuộc tính continueOnError
cho phần tử <OASValidation>
thành true.
Giá trị mặc định | false |
Bắt buộc? | Không bắt buộc |
Loại | Boolean |
Phần tử mẹ |
<Options>
|
Phần tử con | Không có |
Phần tử <ValidateMessageBody>
sử dụng cú pháp sau:
<OASValidation name="policy_name "> <OASResource>oas://specname [.json|.yaml|.yml]</OASResource> <Options> <ValidateMessageBody>[true|false]</ValidateMessageBody> </Options> ... </OASValidation>
Ví dụ sau đây cho phép xác thực nội dung của phần nội dung thông báo:
<OASValidation name="myoaspolicy"> <OASResource>oas://my-spec.yaml</OASResource> <Options> <ValidateMessageBody>true</ValidateMessageBody> </Options> </OASValidation>
<AllowUnspecifiedParameters>
Định cấu hình hành vi của chính sách nếu có các tham số tiêu đề, truy vấn hoặc cookie trong yêu cầu không được xác định trong OpenAPI Specification.
Giá trị mặc định | Không có |
Bắt buộc? | Không bắt buộc |
Loại | Loại phức tạp |
Phần tử mẹ |
<Options>
|
Phần tử con |
<Header> <Query> <Cookie> |
Phần tử <AllowUnspecifiedParameters>
sử dụng cú pháp sau:
<OASValidation name="policy_name "> <OASResource>oas://specname [.json|.yaml|.yml]</OASResource> <Options> <AllowUnspecifiedParameters> <Header>[true|false]</Header> <Query>[true|false]</Query> <Cookie>[true|false]</Cookie> </AllowUnspecifiedParameters> </Options> ... </OASValidation>
Ví dụ sau đây định cấu hình chính sách để không thành công nếu một tham số tiêu đề, truy vấn hoặc cookie được chỉ định trong yêu cầu không được xác định trong Đặc tả OpenAPI.
<OASValidation name="myoaspolicy"> <OASResource>oas://my-spec.yaml</OASResource> <Options> <AllowUnspecifiedParameters> <Header>false</Header> <Query>false</Query> <Cookie>false</Cookie> </AllowUnspecifiedParameters> </Options> </OASValidation>
<Header>
(con của <AllowUnspecifiedParameters>
)
Định cấu hình hành vi của chính sách nếu có các tham số tiêu đề trong yêu cầu không được xác định trong Quy cách OpenAPI.
Để cho phép chỉ định các tham số tiêu đề trong yêu cầu không được xác định trong Đặc tả OpenAPI, hãy đặt tham số này thành true. Nếu không, hãy đặt tham số này thành false để khiến quá trình thực thi chính sách không thành công.
Giá trị mặc định | true |
Bắt buộc? | Boolean |
Loại | Loại phức tạp |
Phần tử mẹ |
<AllowUnspecifiedParameters>
|
Phần tử con | Không có |
Phần tử <Header>
sử dụng cú pháp sau:
<OASValidation name="policy_name "> <OASResource>oas://specname [.json|.yaml|.yml]</OASResource> <Options> <AllowUnspecifiedParameters> <Header>[true|false]</Header> </AllowUnspecifiedParameters> </Options> ... </OASValidation>
Ví dụ sau đây định cấu hình chính sách để không thành công nếu một tham số tiêu đề được chỉ định trong yêu cầu không được xác định trong OpenAPI Specification.
<OASValidation name="myoaspolicy"> <OASResource>oas://my-spec.yaml</OASResource> <Options> <AllowUnspecifiedParameters> <Header>false</Header> </AllowUnspecifiedParameters> </Options> </OASValidation>
<Query>
(con của <AllowUnspecifiedParameters>
)
Định cấu hình hành vi của chính sách nếu có các tham số truy vấn trong yêu cầu không được xác định trong Thông số kỹ thuật OpenAPI.
Để cho phép chỉ định các tham số truy vấn trong yêu cầu không được xác định trong Đặc tả OpenAPI, hãy đặt tham số này thành true. Nếu không, hãy đặt tham số này thành false để khiến quá trình thực thi chính sách không thành công.
Giá trị mặc định | true |
Bắt buộc? | Boolean |
Loại | Loại phức tạp |
Phần tử mẹ |
<AllowUnspecifiedParameters>
|
Phần tử con | Không có |
Phần tử <Query>
sử dụng cú pháp sau:
<OASValidation name="policy_name "> <OASResource>oas://specname [.json|.yaml|.yml]</OASResource> <Options> <AllowUnspecifiedParameters> <Query>[true|false]</Query> </AllowUnspecifiedParameters> </Options> ... </OASValidation>
Ví dụ sau đây định cấu hình chính sách để thất bại nếu một tham số truy vấn được chỉ định trong yêu cầu không được xác định trong Đặc tả OpenAPI.
<OASValidation name="myoaspolicy"> <OASResource>oas://my-spec.yaml</OASResource> <Options> <AllowUnspecifiedParameters> <Query>false</Query> </AllowUnspecifiedParameters> </Options> </OASValidation>
Định cấu hình hành vi của chính sách nếu có các tham số cookie trong yêu cầu không được xác định trong Quy cách OpenAPI.
Để cho phép chỉ định các tham số cookie trong yêu cầu không được xác định trong Đặc tả OpenAPI, hãy đặt tham số này thành true. Nếu không, hãy đặt tham số này thành false để khiến quá trình thực thi chính sách không thành công.
Giá trị mặc định | true |
Bắt buộc? | Boolean |
Loại | Loại phức tạp |
Phần tử mẹ |
<AllowUnspecifiedParameters>
|
Phần tử con | Không có |
Phần tử <Cookie>
sử dụng cú pháp sau:
<OASValidation name="policy_name "> <OASResource>oas://specname [.json|.yaml|.yml]</OASResource> <Options> <AllowUnspecifiedParameters> <Query>[true|false]</Query> </AllowUnspecifiedParameters> </Options> ... </OASValidation>
Ví dụ sau đây định cấu hình chính sách để thất bại nếu một tham số truy vấn được chỉ định trong yêu cầu không được xác định trong Đặc tả OpenAPI.
<OASValidation name="myoaspolicy"> <OASResource>oas://my-spec.yaml</OASResource> <Options> <AllowUnspecifiedParameters> <Cookie>false</Cookie> </AllowUnspecifiedParameters> </Options> </OASValidation>
<Source>
Thông báo JSON sẽ được đánh giá dựa trên các cuộc tấn công bằng tải trọng JSON. Thông thường, bạn sẽ đặt giá trị này thành request
vì thường thì bạn sẽ cần đánh giá các yêu cầu đến từ ứng dụng khách.
Đặt thành response để đánh giá thông báo phản hồi.
Đặt thành message để tự động đánh giá thông báo yêu cầu khi chính sách được đính kèm vào luồng yêu cầu và thông báo phản hồi khi chính sách được đính kèm vào luồng phản hồi.
Giá trị mặc định | request |
Bắt buộc? | Không bắt buộc |
Loại | Chuỗi |
Phần tử mẹ |
<Source>
|
Phần tử con | Không có |
Phần tử <Source>
sử dụng cú pháp sau:
<OASValidation name="policy_name "> <OASResource>oas://specname [.json|.yaml|.yml]</OASResource> <Source>[message|request|response]</Source> ... </OASValidation>
Ví dụ sau đây sẽ tự động đánh giá thông báo yêu cầu khi chính sách được đính kèm vào luồng yêu cầu và thông báo phản hồi khi chính sách được đính kèm vào luồng phản hồi:
<OASValidation name="myoaspolicy"> <OASResource>oas://my-spec.yaml</OASResource> <Source>message</Source> </OASValidation>
Phần tử <Source>
không có thuộc tính hoặc phần tử con.
Giản đồ
Mỗi loại chính sách được xác định bằng một lược đồ XML (.xsd
). Để tham khảo, bạn có thể xem lược đồ chính sách trên GitHub.
Mã lỗi
Phần này mô tả các mã lỗi và thông báo lỗi được trả về, cũng như các biến lỗi do Edge đặt khi chính sách này kích hoạt lỗi. Thông tin này đóng vai trò quan trọng trong việc phát triển các quy tắc lỗi để xử lý lỗi. Để tìm hiểu thêm, hãy xem Những điều bạn cần biết về lỗi chính sách và Xử lý lỗi.
Lỗi thời gian chạy
Những lỗi này có thể xảy ra khi thực thi chính sách.
Mã lỗi | Trạng thái HTTP | Nguyên nhân | |
---|---|---|---|
steps.oasvalidation.Failed |
500 | Không thể xác thực nội dung thông báo yêu cầu theo Thông số kỹ thuật OpenAPI được cung cấp. | |
steps.oasvalidation.SourceMessageNotAvailable |
500 |
Biến được chỉ định trong phần tử |
|
steps.oasvalidation.NotMessageVariable |
500 |
Phần tử |
build |
Lỗi triển khai
Những lỗi này có thể xảy ra khi bạn triển khai proxy chứa chính sách này.
Tên lỗi | Nguyên nhân | |
---|---|---|
ResourceDoesNotExist |
Thông số kỹ thuật OpenAPI được tham chiếu trong phần tử <OASResource> không tồn tại.
|
|
ResourceCompileFailed |
Thông số kỹ thuật OpenAPI được bao gồm trong quá trình triển khai có lỗi ngăn cản quá trình biên dịch. Điều này thường cho thấy rằng thông số kỹ thuật này không phải là Thông số kỹ thuật OpenAPI 3.0 được định dạng đúng. | |
BadResourceURL |
Không xử lý được Thông số kỹ thuật OpenAPI được tham chiếu trong phần tử <OASResource> . Điều này có thể xảy ra nếu tệp đó không phải là tệp JSON hoặc YAML hoặc URL tệp không được chỉ định chính xác.
|
Biến lỗi
Các biến này được đặt khi chính sách này kích hoạt lỗi trong thời gian chạy. Để biết thêm thông tin, hãy xem bài viết Những điều bạn cần biết về lỗi chính sách.
Biến | Trong đó | Ví dụ: |
---|---|---|
fault.name="fault_name" |
fault_name là tên của lỗi, như liệt kê trong bảng Lỗi thời gian chạy ở trên. Tên lỗi là phần cuối cùng của mã lỗi. | fault.name Matches "ResourceDoesNotExist" |
oasvalidation.policy_name.failed |
policy_name là tên của chính sách báo lỗi do người dùng chỉ định. | oasvalidation.myoaspolicy.failed = true |
Các tính năng được hỗ trợ trong Quy cách OpenAPI
Chính sách OASValidation hỗ trợ các tính năng của OpenAPI Specification được tóm tắt trong bảng sau, theo danh mục. Các tính năng không được hỗ trợ cũng được liệt kê.
Danh mục | Có thể làm | Không được hỗ trợ |
---|---|---|
Định dạng kiểu dữ liệu | boolean date date-time double float int32/int64 ipv4/ipv6 md5 sha1/sha256/sha512 string uri uri-template uuid |
binary byte password |
Đối tượng phân biệt | mapping propertyName |
Không áp dụng |
Đối tượng loại nội dung nghe nhìn | giản đồ | ví dụ về mã hoá ví dụ |
Đối tượng Operations | parameters requestBody responses security (hỗ trợ một phần) |
callbacks deprecated servers |
Đối tượng tham số | allowEmptyValue in ( query , header , path )required responses schema style ( deepObject , form , formmatrix , label , pipeDelimited , simple , spaceDelimited )Lưu ý: deepObject chỉ hỗ trợ các tham số chuỗi; không hỗ trợ mảng và đối tượng lồng nhau.
|
allowReserved deprecated example examples content |
Đối tượng Đường dẫn | delete get head options parameters patch post put trace variables |
máy chủ |
Đối tượng nội dung yêu cầu | application/json application/hal+json application/x-www-form-urlencoded (không hỗ trợ đối tượng encoding )content bắt buộc |
application/xml multipart/form-data text/plain text/xml |
Đối tượng phản hồi | application/json application/hal+json application/x-www-form-urlencoded (không hỗ trợ đối tượng encoding )content headers |
application/xml links text/plain text/xml |
Đối tượng phản hồi | default Mã trạng thái HTTP |
Không áp dụng |
Đối tượng giản đồ | $ref additionalProperties (chỉ có biến thể cờ boolean) allOf (bị bỏ qua nếu additionalProperties là false )anyOf enum exclusiveMaximum/exclusiveMinimum format items maximum/minimum maxItems/minItems maxLength/minLength maxProperties/minProperties multipleOf not nullable oneOf pattern properties required title type uniqueItems |
deprecated example readOnly writeOnly xml |
Đối tượng lược đồ bảo mật | trong (header , query ) (bị bỏ qua nếu type là http )name type ( apiKey , http )
|
bearerFormat flows openIdConnectUrl scheme |
Đối tượng máy chủ | url variables |
Nhiều định nghĩa về máy chủ |