Bagikan melalui

Dokumentasi REST API penyusun API Data dengan Swagger / OpenAPI

  • Artikel

Spesifikasi OpenAPI adalah standar agnostik bahasa pemrograman untuk mendokumenKAN API HTTP. Penyusun API Data mendukung standar OpenAPI dengan kemampuannya untuk:

  • Hasilkan informasi tentang semua entitas yang ditentukan konfigurasi runtime yang diaktifkan REST.
  • Kompilasi informasi ke dalam format yang cocok dengan skema OpenAPI.
  • Mengekspos skema OpenAPI yang dihasilkan melalui UI visual (Swagger) atau file berseri.

Dokumen deskripsi OpenAPI

Penyusun API Data menghasilkan dokumen deskripsi OpenAPI menggunakan konfigurasi runtime yang disediakan dan metadata objek database untuk setiap entitas yang diaktifkan REST yang ditentukan. File skema dihasilkan menggunakan fungsionalitas yang disediakan oleh SDK OpenAPI.NET. Saat ini, file skema dihasilkan sesuai dengan Spesifikasi OpenAPI v3.0.1 yang diformat sebagai JSON.

Dokumen deskripsi OpenAPI dapat diambil dari penyusun Api Data dari jalur:

GET /{rest-path}/openapi

Catatan

Secara default, rest-path nilainya adalah api dan dapat dikonfigurasi. Untuk informasi selengkapnya, lihat Konfigurasi REST

SwaggerUI

Antarmuka pengguna Swagger menawarkan UI berbasis web yang menyediakan informasi tentang layanan, menggunakan spesifikasi OpenAPI yang dihasilkan.

Dalam Development mode, penyusun Api Data memungkinkan melihat dokumen deskripsi OpenAPI yang dihasilkan dari titik akhir khusus:

GET /swagger

Titik akhir "Swagger" tidak ditumpuk di bawah rest-path untuk menghindari konflik penamaan dengan entitas yang dikonfigurasi runtime.

Konten terkait