Hasilkan spesifikasi OpenAPI

Sekilas
Tujuan: Membuat spesifikasi OpenAPI dari permintaan API yang disadap
Waktu: 10 menit
Plugins:OpenApiSpecGeneratorPlugin
Prasyarat:Menyiapkan Proksi Dev

Dev Proxy memungkinkan Anda menghasilkan spesifikasi OpenAPI dari permintaan dan respons API yang disadap. Menggunakan Dev Proxy, Anda dapat dengan cepat membuat spesifikasi OpenAPI untuk API yang ada dan mendapat manfaat dari alat yang mendukung OpenAPI.

Untuk menghasilkan spesifikasi OpenAPI menggunakan Dev Proxy:

1. Dalam file konfigurasi, aktifkan OpenApiSpecGeneratorPlugin plugin:

   File: devproxyrc.json

   {
     "plugins": [
       {
         "name": "OpenApiSpecGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll"
       }
     ]
     // [...] shortened for brevity
   }
   

2. Dalam file konfigurasi, ke daftar URL yang akan ditonton, tambahkan URL API yang ingin Anda hasilkan spesifikasi OpenAPInya:

   File: devproxyrc.json

   { 
     "urlsToWatch": [
       "https://api.example.com/*",
     ]
     // [...] shortened for brevity
   }
   

   Tip

   Untuk membuat spesifikasi OpenAPI yang lebih baik, pertimbangkan untuk menggunakan model bahasa lokal dengan Dev Proxy. Untuk informasi selengkapnya, lihat Menggunakan model bahasa lokal.

3. Mulai Proksi Dev:

   devproxy
   

4. Mulai merekam permintaan dengan menekan r

5. Lakukan permintaan yang ingin Anda sertakan dalam spesifikasi OpenAPI

6. Hentikan perekaman permintaan dengan menekan s

7. Dev Proxy menghasilkan spesifikasi OpenAPI dan menyimpannya ke file di direktori saat ini. Dev Proxy memberi nama file setelah nama host API diikuti dengan tanggal dan waktu saat ini, misalnya: api.example.com-20231219091700.json.

Lihat juga

• OpenApiSpecGeneratorPlugin - Referensi lengkap
• Menggunakan model bahasa lokal - Meningkatkan spesifikasi yang dihasilkan
• Apa itu spesifikasi OpenAPI - Konsep
• Glosarium - Terminologi Proxy Pengembang