HTTP dosyası oluşturma

Bir bakışta
Hedef: Yeniden kullanım için kesilen API isteklerinden HTTP dosyası oluşturma
Süre: 10 dakika
Eklentiler:HttpFileGeneratorPlugin
Önkoşullar:Geliştirme Ara Sunucusunu Ayarlama

Geliştirme Proxy'si, kesilen API isteklerinden ve yanıtlarından bir HTTP dosyası oluşturmanıza olanak tanır. HTTP dosyalarını kullanmak özellikle API davranışını simüle etmek veya yeniden üretilebilir API etkileşimlerini paylaşmak isteyen geliştiriciler için yararlıdır. HTTP dosyası, güvenlik ve yeniden kullanılabilirlik değişkenleriyle değiştirilen hassas bilgilerle tüm ilgili istek ve yanıt ayrıntılarını içerir.

Dev Proxy kullanarak bir HTTP dosyası oluşturmak için:

1. Yapılandırma dosyasında öğesini HttpFileGeneratorPluginetkinleştirin:

   Dosya: 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. Eklentiyi isteğe bağlı olarak yapılandırmak için includeOptionsRequests özelliğini httpFileGeneratorPlugin bölümüne ekleyin. Bu özellik, OPTIONS isteklerin oluşturulan HTTP dosyasına dahil edilip edilmeyeceğini belirler. Varsayılan false değeridir.

3. Yapılandırma dosyasında, izleyebileceğiniz URL'ler listesine, HTTP dosyası oluşturmak istediğiniz API'nin URL'sini ekleyin.

   Yapılandırma dosyasının tamamı şöyle görünür.

   Dosya: 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. Geliştirme Ara Sunucusunu Başlat:

   devproxy
   

5. tuşuna basarak ristekleri kaydetmeye başlayın.

6. HTTP dosyasına eklemek istediğiniz API isteklerini gerçekleştirin.

7. tuşuna basarak skaydı durdurun.

8. Dev Proxy bir HTTP dosyası oluşturur ve geçerli dizine kaydeder. Dosya, yakalanan tüm istekleri ve yanıtları içerir ve taşıyıcı belirteçleri ve API anahtarları gibi hassas veriler değişkenlerle değiştirilir. Örneğin:

   @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
   

   Eklenti, her konak adı ve hassas parametre bileşimi için otomatik olarak değişkenler oluşturur ve uygun olduğunda bunları istekler arasında yeniden kullanır.

Sonraki Adımlar

HttpFileGeneratorPlugin hakkında daha fazla bilgi edinin.

HttpFileGeneratorPlugin

Ayrıca bakınız

• HttpFileGeneratorPlugin - Kapsamlı referans
• Ara sunucu etkinliğini kaydetme ve dışarı aktarma - İş akışını kaydetme
• Sözlük - Geliştirme Ara Sunucusu terminolojisi