Menghasilkan file TypeSpec

Sekilas
Tujuan: Membuat TypeSpec dari permintaan yang diintersepsi
Waktu: 10 menit
Plugins:TypeSpecGeneratorPlugin
Prasyarat:Menyiapkan Proksi Dev

Dev Proxy memungkinkan Anda membuat file TypeSpec dari permintaan dan respons API yang disadap. Dengan menggunakan Dev Proxy, Anda dapat dengan cepat membuat file TypeSpec untuk API yang ada dan mendapat manfaat dari alat yang mendukung TypeSpec.

Untuk menghasilkan file TypeSpec menggunakan Dev Proxy:

1. Dalam file konfigurasi, aktifkan TypeSpecGeneratorPlugin plugin:

   File: devproxyrc.json

   {
     "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.1.0/rc.schema.json",
     "plugins": [
       {
         "name": "TypeSpecGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
         "configSection": "typeSpecGeneratorPlugin"
       }
     ],
     "urlsToWatch": [
       "https://api.example.com/*"
     ],
     "typeSpecGeneratorPlugin": {
       "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.1.0/typespecgeneratorplugin.schema.json",
       "ignoreResponseTypes": false
     }
   }
   

2. Secara opsional, konfigurasikan bagian typeSpecGeneratorPlugin . Atur ignoreResponseTypes ke false (default) agar plugin menghasilkan jenis respons.

3. Dalam file konfigurasi, ke daftar URL yang akan ditonton, tambahkan URL API yang ingin Anda buat file TypeSpec-nya.

   Petunjuk / Saran

   Untuk membuat file TypeSpec yang lebih baik, pertimbangkan untuk menggunakan model bahasa lokal dengan Dev Proxy. Menggunakan model bahasa lokal, TypeSpecGeneratorPlugin menghasilkan ID dan deskripsi operasi yang lebih jelas, memberi Anda titik awal yang lebih baik untuk file TypeSpec Anda. Untuk informasi selengkapnya, lihat Menggunakan model bahasa lokal.

4. Mulai Proksi Dev:

   devproxy
   

5. Mulai merekam permintaan dengan menekan r

6. Lakukan permintaan yang ingin Anda sertakan dalam file TypeSpec

7. Hentikan perekaman permintaan dengan menekan s

8. Dev Proxy menghasilkan file TypeSpec 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.tsp.

Langkah selanjutnya

Pelajari selengkapnya tentang TypeSpecGeneratorPlugin.

TypeSpecGeneratorPlugin

Lihat juga

• Hasilkan spesifikasi OpenAPI
• Menggunakan model bahasa lokal
• Merekam dan mengekspor aktivitas proksi