Bagikan melalui


Membuat file HTTP

Sekilas
Tujuan: Membuat file HTTP dari permintaan API yang disadap untuk digunakan kembali
Waktu: 10 menit
Plugins:HttpFileGeneratorPlugin
Prasyarat:Menyiapkan Proksi Dev

Dev Proxy memungkinkan Anda membuat file HTTP dari permintaan dan respons API yang dicegat. Menggunakan file HTTP sangat berguna bagi pengembang yang ingin mensimulasikan perilaku API atau berbagi interaksi API yang dapat direproduksi. File HTTP mencakup semua detail permintaan dan respons yang relevan, dengan informasi sensitif digantikan oleh variabel untuk keamanan dan penggunaan kembali.

Untuk menghasilkan file HTTP menggunakan Proksi Dev:

  1. Dalam file konfigurasi, aktifkan HttpFileGeneratorPlugin:

    File: devproxyrc.json

    {
      "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/rc.schema.json",
      "plugins": [
        {
          "name": "HttpFileGeneratorPlugin",
          "enabled": true,
          "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
          "configSection": "httpFileGeneratorPlugin"
        }
      ],
      "urlsToWatch": [
        "https://api.example.com/*"
      ],
      "httpFileGeneratorPlugin": {
        "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/httpfilegeneratorplugin.schema.json",
        "includeOptionsRequests": false
      }
    }
    
  2. Secara opsional, konfigurasikan plugin dengan menambahkan includeOptionsRequests properti ke bagian httpFileGeneratorPlugin . Properti ini menentukan apakah akan menyertakan OPTIONS permintaan dalam file HTTP yang dihasilkan. Defaultnya adalah false.

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

    File konfigurasi lengkap terlihat seperti ini.

    File: devproxyrc.json

    {
      "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/rc.schema.json",
      "plugins": [
        {
          "name": "HttpFileGeneratorPlugin",
          "enabled": true,
          "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
          "configSection": "httpFileGeneratorPlugin"
        }
      ],
      "urlsToWatch": [
        "https://api.example.com/*"
      ],
      "httpFileGeneratorPlugin": {
        "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/httpfilegeneratorplugin.schema.json",
        "includeOptionsRequests": false
      }
    }
    
  4. Mulai Proksi Dev:

    devproxy
    
  5. Mulai rekam permintaan dengan menekan r.

  6. Lakukan permintaan API yang ingin Anda sertakan dalam file HTTP.

  7. Hentikan perekaman dengan menekan s.

  8. Dev Proxy menghasilkan file HTTP dan menyimpannya di direktori saat ini. File ini mencakup semua permintaan dan respons yang diambil, dengan data sensitif seperti token pembawa dan kunci API digantikan oleh variabel. Contohnya:

    @jsonplaceholder_typicode_com_api_key = api-key
    ###
    # @name getPosts
    GET https://jsonplaceholder.typicode.com/posts?api-key={{jsonplaceholder_typicode_com_api_key}}
    Host: jsonplaceholder.typicode.com
    User-Agent: curl/8.6.0
    Accept: */*
    Via: 1.1 dev-proxy/0.29.0
    

    Plugin secara otomatis membuat variabel untuk setiap kombinasi nama host dan parameter sensitif, menggunakannya kembali di seluruh permintaan jika berlaku.

Cuplikan layar dua jendela prompt perintah. Satu menunjukkan permintaan API perekaman Proksi Dev. Yang lain menunjukkan file HTTP yang dihasilkan.

Langkah selanjutnya

Pelajari selengkapnya tentang HttpFileGeneratorPlugin.

Lihat juga