OpenAPI untuk pembangun API data

Spesifikasi OpenAPI adalah standar bahasa-agnostik untuk mendokumen API HTTP. Penyusun API Data mendukung OpenAPI dengan:

• Menghasilkan metadata untuk semua entitas yang diaktifkan REST yang ditentukan dalam konfigurasi runtime
• Mengkompilasi metadata tersebut ke dalam skema OpenAPI yang valid
• Mengekspos skema melalui UI visual (Swagger) atau sebagai file JSON berseri

Dokumen deskripsi OpenAPI

Penyusun API Data menghasilkan dokumen deskripsi OpenAPI menggunakan konfigurasi runtime dan metadata database untuk setiap entitas yang diaktifkan REST.

Skema ini dibangun menggunakan SDK OpenAPI.NET dan sesuai dengan Spesifikasi OpenAPI v3.0.1. Ini adalah output sebagai dokumen JSON.

Anda dapat mengakses dokumen OpenAPI di:

GET /{rest-path}/openapi

[! CATATAN] Secara default, rest-path adalah api. Nilai ini dapat dikonfigurasi. Lihat Konfigurasi REST untuk detailnya.

Swagger UI

Antarmuka pengguna Swagger menyediakan tampilan INTERAKTIF berbasis web API berdasarkan skema OpenAPI.

Dalam Development mode, penyusun DATA API mengekspos antarmuka pengguna Swagger di:

GET /swagger

Titik akhir ini tidak berada di bawah rest-path untuk menghindari konflik dengan entitas yang ditentukan pengguna.