Kebijakan OASValidation

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

Tentang kebijakan OASValidation

Kebijakan OASValidation (OpenAPI Specification Validation) memungkinkan Anda memvalidasi permintaan masuk atau pesan respons terhadap Spesifikasi OpenAPI 3.0, menggunakan format JSON atau YAML. Lihat Konten apa yang divalidasi?

Kebijakan OASValidation menentukan nama Spesifikasi OpenAPI yang akan digunakan untuk validasi saat langkah yang disertai kebijakan dijalankan. Spesifikasi OpenAPI disimpan sebagai resource di lokasi standar berikut dalam paket proxy API: apiproxy/resources/oas. Dokumen Spesifikasi OpenAPI harus memiliki ekstensi .json, .yml, atau .yaml.

Tambahkan Spesifikasi OpenAPI sebagai resource ke paket proxy API menggunakan UI atau API, seperti yang dijelaskan dalam Mengelola resource.

Kebijakan ini adalah Kebijakan standar dan dapat di-deploy ke jenis lingkungan apa pun. Tidak semua pengguna perlu mengetahui tentang kebijakan dan jenis lingkungan. Untuk mengetahui informasi tentang jenis kebijakan dan ketersediaan untuk setiap jenis lingkungan, lihat Jenis kebijakan.

Catatan: Anda hanya dapat menyimpan Spesifikasi OpenAPI dengan revisi proxy API saja. Lihat Tempat resource disimpan.

Konten apa yang divalidasi?

Tabel berikut meringkas konten pesan permintaan yang divalidasi oleh kebijakan OASValidation, berdasarkan komponen.

Komponen	Minta validasi
{i>Basepath<i}	Memvalidasi jalur dasar yang ditentukan oleh proxy API; mengabaikan jalur dasar yang ditentukan dalam Spesifikasi OpenAPI.
Jalur	Memvalidasi bahwa jalur permintaan (dikurangi jalur dasar) cocok dengan salah satu pola jalur yang ditetapkan dalam Spesifikasi OpenAPI.
Kata kerja	Memvalidasi bahwa kata kerja didefinisikan untuk jalur dalam Spesifikasi OpenAPI.
Isi pesan permintaan	Memvalidasi keberadaan isi pesan dalam permintaan, jika diperlukan. Secara opsional, memvalidasi isi pesan terhadap skema isi permintaan operasi dalam Spesifikasi OpenAPI. Konfigurasikan opsi ini menggunakan <ValidateMessageBody> Catatan: Kebijakan ini memvalidasi isi pesan permintaan terhadap Spesifikasi OpenAPI hanya jika Content-Type disetel ke application/json. Jika jenis konten tidak ditetapkan ke application/json, validasi isi pesan permintaan akan otomatis diteruskan (tanpa benar-benar memvalidasi konten).
Parameter	Memvalidasi bahwa parameter yang diperlukan ada dalam permintaan, termasuk parameter jalur, header, kueri, dan cookie. Memvalidasi bahwa nilai parameter cocok dengan nilai yang ditetapkan dalam Spesifikasi OpenAPI. Secara opsional, memvalidasi apakah ada parameter dalam permintaan yang tidak ditetapkan dalam Spesifikasi OpenAPI. Konfigurasikan opsi ini menggunakan <AllowUnspecifiedParameters>

Tabel berikut meringkas konten pesan respons yang divalidasi oleh kebijakan OASValidation, berdasarkan komponen.

Komponen	Validasi jawaban
Jalur	Memvalidasi bahwa jalur permintaan (dikurangi jalur dasar) cocok dengan salah satu pola jalur yang ditetapkan dalam Spesifikasi OpenAPI.
Kata kerja	Memvalidasi bahwa kata kerja didefinisikan untuk jalur dalam Spesifikasi OpenAPI.
Isi pesan respons	Memvalidasi keberadaan isi pesan dalam respons, jika diperlukan. Memvalidasi bahwa header respons dalam Spesifikasi OpenAPI ada dalam pesan respons, dan bahwa nilai header respons cocok dengan skema. Secara opsional, memvalidasi isi pesan terhadap skema isi respons operasi dalam Spesifikasi OpenAPI. Konfigurasikan opsi ini menggunakan <ValidateMessageBody>

Sampel

Contoh berikut menunjukkan beberapa cara penggunaan kebijakan OASValidation untuk memvalidasi pesan terhadap Spesifikasi OpenAPI 3.0.

Validasi pesan permintaan

Dalam contoh berikut, kebijakan myoaspolicy memvalidasi isi pesan permintaan terhadap skema isi pesan permintaan operasi yang ditentukan dalam Spesifikasi OpenAPI my-spec.json.

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.json</OASResource>
   <Options>
      <ValidateMessageBody>true</ValidateMessageBody>
   </Options>
   <Source>request</Source>
</OASValidation>

Jika isi pesan tidak sesuai dengan Spesifikasi OpenAPI, error policies.oasvalidation.Failed akan ditampilkan.

Validasi parameter

Contoh berikut mengonfigurasi kebijakan untuk gagal jika header, kueri, atau parameter cookie ditentukan dalam permintaan yang tidak ditentukan dalam Spesifikasi OpenAPI.

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Header>false</Header>
         <Query>false</Query>
         <Cookie>false</Cookie>
      </AllowUnspecifiedParameters>
   </Options>
</OASValidation>

Elemen <OASValidation>

Menentukan kebijakan Validasi Spesifikasi OpenAPI.

Nilai Default	Lihat tab Kebijakan Default di bawah
Wajib?	Diperlukan
Jenis	Objek kompleks
Elemen Induk	t/a
Elemen Turunan	<DisplayName> <OASResource> <Source> <Options> <Source>

Sintaksis

Elemen <OASValidation> menggunakan sintaksis berikut:

<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>

Kebijakan Default

Contoh berikut menunjukkan setelan default saat Anda menambahkan kebijakan Validasi OAS ke alur di UI 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>

Elemen ini memiliki atribut berikut yang sama untuk semua kebijakan:

Atribut	Default	Wajib?	Deskripsi
name	T/A	Wajib	Nama internal kebijakan. Nilai atribut name dapat berisi huruf, angka, spasi, tanda hubung, garis bawah, dan titik. Nilai ini tidak boleh melebihi 255 karakter. Atau, gunakan elemen <DisplayName> untuk memberi label kebijakan di editor proxy UI pengelolaan dengan nama natural-language yang berbeda.
continueOnError	false	Opsional	Setel ke false untuk menampilkan error jika kebijakan gagal. Ini adalah perilaku yang wajar untuk sebagian besar kebijakan. Setel ke true agar eksekusi alur tetap berlanjut bahkan setelah kebijakan gagal. Lihat juga: Aturan error HANYA dipicu dalam status error (tentang continueOnError) Menangani kesalahan dalam alur saat ini
enabled	true	Opsional	Setel ke true untuk menerapkan kebijakan. Setel ke false untuk menonaktifkan kebijakan. Kebijakan tidak akan diterapkan meskipun tetap melekat pada alur.
async	false	Tidak digunakan lagi	Atribut ini sudah tidak digunakan lagi.

Referensi elemen turunan

Bagian ini menjelaskan elemen turunan <OASValidation>.

<DisplayName>

Gunakan selain atribut name untuk memberi label kebijakan di editor proxy UI pengelolaan dengan nama yang berbeda dan lebih alami.

Elemen <DisplayName> bersifat umum untuk semua kebijakan.

Nilai Default	T/A
Wajib?	Opsional. Jika Anda menghilangkan <DisplayName>, nilai atribut name kebijakan akan digunakan.
Jenis	String
Elemen Induk	<PolicyElement>
Elemen Turunan	Tidak ada

Elemen <DisplayName> menggunakan sintaksis berikut:

Sintaksis

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

Contoh

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

Elemen <DisplayName> tidak memiliki atribut atau elemen turunan.

<OASResource>

Menentukan Spesifikasi OpenAPI yang akan divalidasi. Anda dapat menyimpan file ini:

• Pada cakupan proxy API di bagian /apiproxy/resources/oas dalam paket proxy API
• Di bagian Resources pada tampilan Navigator editor proxy API.

Untuk mengetahui informasi selengkapnya, lihat Mengelola fasilitas.

Anda dapat menentukan Spesifikasi OpenAPI menggunakan template pesan, seperti {oas.resource.url}. Dalam hal ini, nilai variabel flow oas.resource.url (dalam tanda kurung kurawal) akan dievaluasi dan diganti menjadi string payload saat runtime. Untuk mengetahui informasi selengkapnya, lihat Template pesan.

Nilai Default	Tidak ada
Wajib?	Diperlukan
Jenis	String
Elemen Induk	<OASValidation>
Elemen Turunan	Tidak ada

Sintaksis

Elemen <OASResource> menggunakan sintaksis berikut:

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   ...
</OASValidation>

Contoh

Contoh berikut merujuk ke spesifikasi my-spec.yaml yang disimpan di /apiproxy/resources/oas dalam paket proxy API:

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
</OASValidation>

Elemen <OASResource> tidak memiliki atribut atau elemen turunan.

Catatan: Jika kebijakan OASValidation menentukan <OASResource> dengan persyaratan keamanan yang ditetapkan di tingkat global, persyaratan keamanan tidak akan diterapkan. Untuk memastikan penerapan, semua persyaratan keamanan harus ditetapkan di level operation dalam spesifikasi OpenAPI yang diteruskan dalam elemen <OASResource> kebijakan ini. Untuk mengetahui informasi selengkapnya, lihat Masalah Umum Apigee.

<Opsi>

Mengonfigurasi opsi untuk kebijakan.

Nilai Default	t/a
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	<OASValidation>
Elemen Turunan	<ValidateMessageBody> <AllowUnspecifiedParameters>

Sintaksis

Elemen <Options> menggunakan sintaksis berikut:

<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>

Contoh

Contoh berikut mengonfigurasi opsi untuk kebijakan. Setiap opsi dijelaskan secara lebih mendetail di bawah.

<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>

Menentukan apakah kebijakan harus memvalidasi isi pesan terhadap skema isi permintaan operasi dalam Spesifikasi OpenAPI. Tetapkan ke true untuk memvalidasi konten isi pesan. Tetapkan ke false untuk memvalidasi hanya bahwa isi pesan ada.

Anda dapat mengontrol apakah eksekusi alur akan terus berlanjut setelah error validasi dengan menetapkan atribut continueOnError untuk elemen <OASValidation> ke true.

Catatan: Kebijakan ini memvalidasi isi pesan permintaan terhadap Spesifikasi OpenAPI hanya jika Content-Type disetel ke application/json. Jika jenis konten tidak ditetapkan ke application/json, validasi isi pesan permintaan akan berhasil secara otomatis (tanpa benar-benar memvalidasi konten).

Nilai Default	false
Wajib?	Opsional
Jenis	Boolean
Elemen Induk	<Options>
Elemen Turunan	Tidak ada

Sintaksis

Elemen <ValidateMessageBody> menggunakan sintaksis berikut:

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Options>
         <ValidateMessageBody>[true|false]</ValidateMessageBody>
   </Options>
   ...
</OASValidation>

Contoh

Contoh berikut memungkinkan validasi konten isi pesan:

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <ValidateMessageBody>true</ValidateMessageBody>
   </Options>
</OASValidation>

<AllowUnspecifiedParameters>

Mengonfigurasi perilaku kebijakan jika ada parameter header, kueri, atau cookie dalam permintaan yang tidak ditentukan dalam Spesifikasi OpenAPI.

Nilai Default	t/a
Wajib?	Opsional
Jenis	Jenis kompleks
Elemen Induk	<Options>
Elemen Turunan	<Header> <Query> <Cookie>

Sintaksis

Elemen <AllowUnspecifiedParameters> menggunakan sintaksis berikut:

<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>

Contoh

Contoh berikut mengonfigurasi kebijakan untuk gagal jika header, kueri, atau parameter cookie ditentukan dalam permintaan yang tidak ditentukan dalam Spesifikasi 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> (turunan dari <AllowUnspecifiedParameters>)

Mengonfigurasi perilaku kebijakan jika ada parameter header dalam permintaan yang tidak ditentukan dalam Spesifikasi OpenAPI.

Agar parameter header dapat ditentukan dalam permintaan yang tidak ditetapkan dalam Spesifikasi OpenAPI, tetapkan parameter ini ke true. Jika tidak, tetapkan parameter ini ke false agar eksekusi kebijakan gagal.

Nilai Default	true
Wajib?	Boolean
Jenis	Jenis kompleks
Elemen Induk	<AllowUnspecifiedParameters>
Elemen Turunan	Tidak ada

Sintaksis

Elemen <Header> menggunakan sintaksis berikut:

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Header>[true|false]</Header>
      </AllowUnspecifiedParameters>
   </Options>
   ...
</OASValidation>

Contoh

Contoh berikut mengonfigurasi kebijakan untuk gagal jika parameter header ditentukan dalam permintaan yang tidak ditentukan dalam Spesifikasi OpenAPI.

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Header>false</Header>
      </AllowUnspecifiedParameters>
   </Options>
</OASValidation>

<Query> (turunan dari <AllowUnspecifiedParameters>)

Mengonfigurasi perilaku kebijakan jika ada parameter kueri dalam permintaan yang tidak ditentukan dalam Spesifikasi OpenAPI.

Agar parameter kueri dapat ditentukan dalam permintaan yang tidak ditetapkan dalam Spesifikasi OpenAPI, tetapkan parameter ini ke true. Jika tidak, tetapkan parameter ini ke false agar eksekusi kebijakan gagal.

Nilai Default	true
Wajib?	Boolean
Jenis	Jenis kompleks
Elemen Induk	<AllowUnspecifiedParameters>
Elemen Turunan	Tidak ada

Sintaksis

Elemen <Query> menggunakan sintaksis berikut:

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Query>[true|false]</Query>
      </AllowUnspecifiedParameters>
   </Options>
   ...
</OASValidation>

Contoh

Contoh berikut mengonfigurasi kebijakan untuk gagal jika parameter kueri ditentukan dalam permintaan yang tidak ditentukan dalam Spesifikasi OpenAPI.

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Query>false</Query>
      </AllowUnspecifiedParameters>
   </Options>
</OASValidation>

<Cookie> (turunan dari <AllowUnspecifiedParameters>)

Mengonfigurasi perilaku kebijakan jika ada parameter cookie dalam permintaan yang tidak ditentukan dalam Spesifikasi OpenAPI.

Agar parameter cookie dapat ditentukan dalam permintaan yang tidak ditetapkan dalam Spesifikasi OpenAPI, tetapkan parameter ini ke true. Jika tidak, tetapkan parameter ini ke false agar eksekusi kebijakan gagal.

Nilai Default	true
Wajib?	Boolean
Jenis	Jenis kompleks
Elemen Induk	<AllowUnspecifiedParameters>
Elemen Turunan	Tidak ada

Sintaksis

Elemen <Cookie> menggunakan sintaksis berikut:

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Query>[true|false]</Query>
      </AllowUnspecifiedParameters>
   </Options>
   ...
</OASValidation>

Contoh

Contoh berikut mengonfigurasi kebijakan untuk gagal jika parameter kueri ditentukan dalam permintaan yang tidak ditentukan dalam Spesifikasi OpenAPI.

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Options>
      <AllowUnspecifiedParameters>
         <Cookie>false</Cookie>
      </AllowUnspecifiedParameters>
   </Options>
</OASValidation>

<Source>

Pesan JSON yang akan dievaluasi terhadap serangan payload JSON. Nilai ini paling sering ditetapkan ke request, karena Anda biasanya harus mengevaluasi permintaan masuk dari aplikasi klien. Setel ke response untuk mengevaluasi pesan respons. Setel ke message untuk mengevaluasi pesan permintaan secara otomatis ketika kebijakan dilampirkan ke alur permintaan dan pesan respons saat kebijakan dilampirkan ke alur respons.

Nilai Default	permintaan
Wajib?	Opsional
Jenis	String
Elemen Induk	<Source>
Elemen Turunan	Tidak ada

Sintaksis

Elemen <Source> menggunakan sintaksis berikut:

<OASValidation name="policy_name">
   <OASResource>oas://specname[.json|.yaml|.yml]</OASResource>
   <Source>[message|request|response]</Source>
   ...
</OASValidation>

Contoh

Contoh berikut mengevaluasi pesan permintaan secara otomatis saat kebijakan dilampirkan ke alur permintaan dan pesan respons saat kebijakan dilampirkan ke alur respons:

<OASValidation name="myoaspolicy">
   <OASResource>oas://my-spec.yaml</OASResource>
   <Source>message</Source>
</OASValidation>

Elemen <Source> tidak memiliki atribut atau elemen turunan.

Skema untuk kebijakan ini

Setiap jenis kebijakan ditentukan oleh skema XML (.xsd). Untuk referensi, skema kebijakan tersedia di GitHub.

Kode error

Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan dan variabel kesalahan yang disetel oleh Apigee saat kebijakan ini memicu error. Informasi ini penting untuk diketahui apakah Anda mengembangkan aturan kesalahan untuk menangani kesalahan. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

Kode kesalahan	Status HTTP	Penyebab
steps.oasvalidation.Failed	400	Isi pesan Permintaan tidak dapat divalidasi berdasarkan Spesifikasi OpenAPI yang diberikan.
steps.oasvalidation.Failed	500	Isi pesan Response tidak dapat divalidasi dengan Spesifikasi OpenAPI yang diberikan.
steps.oasvalidation.SourceMessageNotAvailable	500	Variabel yang ditentukan dalam elemen <Source> kebijakan berada di luar cakupan atau tidak dapat diselesaikan.
steps.oasvalidation.NonMessageVariable	500	Elemen <Source> ditetapkan ke variabel yang bukan jenis message.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Nama error	Penyebab
ResourceDoesNotExist	Spesifikasi OpenAPI yang dirujuk dalam elemen <OASResource> tidak ada.
ResourceCompileFailed	Spesifikasi OpenAPI yang disertakan dalam deployment berisi error yang mencegahnya dikompilasi. Hal ini secara umum menunjukkan bahwa spesifikasi tersebut bukan Spesifikasi OpenAPI 3.0 yang diformat dengan baik.
BadResourceURL	Spesifikasi OpenAPI yang direferensikan dalam elemen <OASResource> tidak dapat diproses. Hal ini dapat terjadi jika file bukan file JSON atau YAML, atau URL file tidak ditentukan dengan benar.

Variabel kesalahan

Variabel ini ditetapkan saat kebijakan ini memicu error saat runtime. Untuk informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Deskripsi	Contoh
fault.category	Kategori kesalahan. Jika kebijakan menolak permintaan, Step akan selalu ditahan.	fault.category = "Step"
fault.name	Nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan.	fault.name Matches "ResourceDoesNotExist"
fault.reason	Alasan kesalahan. Ini adalah string yang dapat dibaca manusia yang menjelaskan alasan kesalahan.	OASValidation OAS-1 with resource "oas://my-spec1.yaml": failed with reason: "[ERROR - POST operation not allowed on path '/persons/13'.: []]"
fault.subcategory	Subkategori kesalahan. Jika kebijakan menolak permintaan, OASValidationFailure akan selalu ditahan.	fault.subcategory = "OASValidationFailure"
OASValidation.policy_name.failed	policy_name adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan.	OASValidation.myoaspolicy.failed = true

Fitur Spesifikasi OpenAPI yang didukung

Kebijakan OASValidation mendukung fitur Spesifikasi OpenAPI yang dirangkum dalam tabel berikut, berdasarkan kategori. Fitur yang tidak didukung juga tercantum.

Catatan: Kebijakan OASValidation akan menolak Spesifikasi OpenAPI yang menggunakan fitur yang tidak didukung. Dalam hal ini, kebijakan tidak akan lulus validasi fitur yang tidak didukung dan deployment proxy API gagal.

Kategori	Didukung	Tidak didukung
Format jenis data	boolean tanggal tanggal-waktu ganda email float int32/int64 ipv4/ipv6 md5 sha1/sha256/sha512 string uri uri-template uuid	biner byte sandi
Objek diskriminator	pemetaan propertyName	T/A
Objek jenis media	schema	contoh encoding contoh
Objek operasi	parameter requestBody responses security (dukungan parsial)	callback server tidak digunakan lagi
Objek parameter	allowEmptyValue in (query, header, path) respons yang diperlukan skema (deepObject, form, formmatrix, label, pipeDelimited, simple, spaceDelimited) Catatan: deepObject hanya mendukung parameter string; array dan objek bertingkat tidak didukung.	allowReserved tidak digunakan lagi contoh contoh konten
Objek jalur	hapus dapatkan head opsi parameter patch post put trace variabel	server
Minta objek isi	application/json application/hal+json application/x-www-form-urlencoding (objek encoding tidak didukung) content wajib	application/xml multipart/form-data teks/biasa teks/xml
Objek respons	application/json application/hal+json application/x-www-form-urlcoded (objek encoding tidak didukung) header contents	link aplikasi/xml teks/biasa teks/xml
Objek respons	default Kode Status HTTP	T/A
Objek skema	$ref additionalProperties (khusus varian tanda boolean) allOf (diabaikan jika additionalProperties adalah false) salah satu enum	tidak digunakan lagi contoh readOnly writeOnly xml
Objek skema keamanan	dalam (header, query) (diabaikan jika type adalah http) nama jenis (apiKey, http)	BearerFormat alur openIdConnectUrl skema
Objek server	URL variabel	Beberapa definisi server

Menggunakan pola dalam skema

Standar Spesifikasi OpenAPI memungkinkan spesifikasi untuk menetapkan schema guna mendeskripsikan jenis data suatu parameter atau kolom. Untuk parameter atau kolom string jenis, skema juga dapat menentukan pattern, yang merupakan ekspresi reguler (regex) yang menentukan formulir valid untuk string tersebut.

Sebagai contoh, perhatikan fragmen Spesifikasi OpenAPI berikut:

paths:
  /products/{product-id}:
    get:
      operationId: getProduct
      summary: Get product by id
      description: returns information regarding a product, by id
      parameters:
        - name: product-id
          in: path
          description: id of the product
          required: true
          schema:
            type: string
            pattern: '^\w{3}-\d{4}$'

Spesifikasi ini mengharuskan parameter product-id untuk operasi getProduct sesuai dengan ekspresi reguler yang diberikan, yang menetapkan urutan 3 karakter kata, tanda hubung, dan 4 digit desimal.

Spesifikasi OpenAPI menangguhkan standar Validasi Skema JSON untuk secara formal menentukan perilaku pola dalam memvalidasi nilai string, dan pada standar Inti Skema JSON untuk memberikan rekomendasi kepada penulis skema terkait kumpulan sintaksis ekspresi reguler yang dibatasi. Standar yang terakhir tersebut merekomendasikan untuk menghindari penggunaan area pandang (lookahead dan Lookbehind), backreference, dan ekspresi karakter oktal, di antara fitur-fitur lainnya, dalam pola di dalam dokumen Spesifikasi OpenAPI.

Secara default, Apigee memvalidasi dokumen Spesifikasi OpenAPI yang dirujuk oleh kebijakan OASValidation dan melaporkan error jika dokumen spesifikasi tidak diformat dengan baik. Apigee juga memvalidasi pola ekspresi reguler dalam dokumen spesifikasi Anda dan melaporkan masalah yang ditemukan di sana.

Penting untuk diperhatikan bahwa jika Anda menggunakan fitur ekspresi reguler di luar subset yang direkomendasikan, Apigee tidak akan memvalidasi ekspresi reguler dan akan menangguhkan validasi tambahan apa pun atas dokumen Spesifikasi OpenAPI Anda. Jika terdapat error dalam dokumen, atau dalam ekspresi reguler yang menggunakan fitur di luar subset yang direkomendasikan, atau jika fitur ekspresi reguler tidak didukung oleh runtime Apigee, error tersebut hanya akan terdeteksi pada saat runtime ketika kebijakan dijalankan.

Tabel berikut memberikan beberapa contoh.

Pola	Perilaku
^\w{3}-\d{4}$	Polanya valid. Tindakan ini hanya menggunakan fitur ekspresi reguler dalam subset yang direkomendasikan. Apigee akan mengizinkan penyimpanan atau impor proxy, dan pada saat runtime, kebijakan OASValidation akan berfungsi sebagaimana mestinya, sehingga memvalidasi parameter terhadap pola tersebut.
^([a-z]\w{3}-\d{4}$	Pola tidak valid; pola tidak memiliki tanda kurung tutup. Pola ini tidak menggunakan fitur ekspresi reguler di luar subset yang direkomendasikan. Apigee akan melaporkan error ini pada saat Anda mengimpor atau menyimpan proxy API.
^(?![a-z]\w{3}-\d{4}$	Polanya tidak valid. Seperti pada contoh sebelumnya, tanda kurung tutup tidak ada. Namun, Apigee tidak akan melaporkan error ini saat Anda menyimpan atau mengimpor Proxy API, karena ekspresi reguler menggunakan Lookahead negatif, yang berada di luar subset fitur ekspresi reguler yang direkomendasikan. Error hanya akan terdeteksi saat runtime ketika kebijakan dieksekusi.
^(?![a-z])\w{3}-\d{4}$	Pola ini valid, tetapi menggunakan pandangan ke depan negatif, yang berada di luar subset fitur ekspresi reguler yang direkomendasikan. Apigee akan menangguhkan validasi dokumen Spesifikasi OpenAPI. Saat runtime, saat Anda mengeksekusi kebijakan OASValidation yang merujuk ke spesifikasi menggunakan pola ini, karena runtime Apigee sebenarnya mendukung tampilan negatif, Apigee akan menerapkan ekspresi reguler ini dengan benar untuk memvalidasi nilai parameter.
^(a)?b(?(1)c|d)$	Polanya valid, tetapi menggunakan kondisional grup perekam, yang berada di luar subset fitur ekspresi reguler yang direkomendasikan. Apigee akan menangguhkan validasi dokumen Spesifikasi OpenAPI. Saat runtime, ketika Anda menjalankan kebijakan OASValidation yang merujuk ke spesifikasi menggunakan pola ini karena runtime Apigee tidak mendukung fitur ekspresi reguler ini, Apigee akan menampilkan error.

Sebaiknya hanya gunakan subset fitur yang direkomendasikan dalam ekspresi reguler Anda untuk mencegah kegagalan runtime.

Topik terkait

• Kebijakan Perlindungan Ancaman JSON
• Kebijakan SOAPMessageValidation