VB.NET වලින් බාහිර API සම්බන්ධ කරගැනීමේ ක්‍රම

අන්තර්ජාල සේවාවකින් දත්ත ලබාගැනීමට හෝ ඔබේ යෙදුමෙන් වෙනත් පද්ධතියකට තොරතුරු යැවීමට බාහිර API භාවිත කළ හැකිය. කාලගුණ තොරතුරු, මුදල් විනිමය අනුපාත, සිතියම්, ගෙවීම් සහ පුවත් වැනි සේවා VB.NET වැඩසටහනකට සම්බන්ධ කිරීමට මෙය ප්‍රයෝජනවත් වේ.

API සම්බන්ධතාවයකදී HTTP ඉල්ලීමක් යවා ප්‍රතිචාරයක් ලබාගැනීම මූලික ක්‍රියාවලියයි. එම ප්‍රතිචාරය බොහෝවිට JSON ආකෘතියෙන් ලැබෙන අතර, එය VB.NET තුළ පන්ති හෝ වස්තු බවට පරිවර්තනය කර භාවිත කළ හැකිය.

ආරම්භකයකුට වැදගත්ම කරුණු වන්නේ API ලිපිනය, ඉල්ලීම් ක්‍රමය, ශීර්ෂ, සත්‍යාපන යතුරු සහ දෝෂ හැසිරවීමයි. පහත ක්‍රම මඟින් සරල API සේවාදායකයක් ක්‍රමයෙන් ගොඩනගාගත හැකිය.

සම්බන්ධතා ක්‍රමය භාවිතය ප්‍රතිලාභ අවධානය යොමු කළ යුතු කරුණ
GET ඉල්ලීම දත්ත කියවීම සරල හා වේගවත් ප්‍රතිචාර ආකෘතිය පරීක්ෂා කිරීම
POST ඉල්ලීම නව දත්ත යැවීම පෝරම දත්ත යැවිය හැක JSON අන්තර්ගතය නිවැරදි වීම
API යතුර සේවාදායකයා හඳුනාගැනීම ප්‍රවේශ පාලනය යතුර කේතය තුළ හෙළි නොකිරීම
JSON පරිවර්තනය ප්‍රතිචාර භාවිතය පන්ති සමඟ පහසු වැඩ කිරීම හිස් හෝ වෙනස් ක්ෂේත්‍ර හැසිරවීම

API ඉල්ලීමේ මූලික ව්‍යුහය

බාහිර API එකක් භාවිත කිරීමට පළමුව එහි ලේඛනය කියවා අවසන් ලක්ෂ්‍යය, අවශ්‍ය පරාමිතීන් සහ පිළිගන්නා HTTP ක්‍රමය හඳුනාගන්න. දත්ත ලබාගැනීමට සාමාන්‍යයෙන් GET ද, නව දත්ත යැවීමට POST ද භාවිත වේ. සමහර සේවා PUT හෝ DELETE ක්‍රමද ලබා දෙයි.

VB.NET හි HttpClient පන්තිය HTTP සන්නිවේදනය සඳහා සුදුසු මෙවලමකි. නව ව්‍යාපෘතියක System.Net.Http නාම අවකාශය ඇතුළත් කර, එකම HttpClient වස්තුව නැවත භාවිත කිරීම සම්බන්ධතා කාර්යක්ෂමතාව වැඩි කරයි. API සම්බන්ධතා පිළිබඳ අමතර උදාහරණ සඳහා ප්‍රායෝගික VB.NET සටහන් කියවීමද ප්‍රයෝජනවත් වේ.

GET මඟින් දත්ත ලබාගැනීම

පහත උදාහරණය API ලිපිනයකින් පෙළ ප්‍රතිචාරයක් ලබාගන්නා ආකාරය පෙන්වයි.

Imports System.Net.Http

Public Class ApiReader
    Private Shared ReadOnly client As New HttpClient()

    Public Shared Async Function GetDataAsync() As Task(Of String)
        Dim address As String = "https://api.example.com/items"
        Dim response As HttpResponseMessage = Await client.GetAsync(address)

        response.EnsureSuccessStatusCode()
        Return Await response.Content.ReadAsStringAsync()
    End Function
End Class

Await භාවිත කිරීමෙන් ජාල ප්‍රතිචාරය ලැබෙන තුරු පරිශීලක අතුරුමුහුණත අවහිර වීම වළක්වයි. EnsureSuccessStatusCode මඟින් 400 හෝ 500 පරාසයේ ප්‍රතිචාරයක් ලැබුණු විට දෝෂයක් ඇති කරයි. සැබෑ යෙදුමකදී එම දෝෂය Try...Catch කොටසකින් පාලනය කළ යුතුය.

POST මඟින් දත්ත යැවීම

සේවාදායකයට පෝරමයක් හෝ නව වාර්තාවක් යැවීමට JSON අන්තර්ගතයක් සකස් කර POST ඉල්ලීමක් යැවිය හැකිය. StringContent භාවිත කරන විට අන්තර්ගත වර්ගය application/json ලෙස සඳහන් කිරීම වැදගත් වේ.

Imports System.Net.Http
Imports System.Text

Dim json As String = "{""name"":""Kamal"",""email"":""kamal@example.com""}"
Dim content As New StringContent(json, Encoding.UTF8, "application/json")

Dim response As HttpResponseMessage =
    Await client.PostAsync("https://api.example.com/users", content)

Dim result As String = Await response.Content.ReadAsStringAsync()

විශාල හෝ සංකීර්ණ දත්ත සඳහා JSON පෙළ අතින් සෑදීම වෙනුවට පන්ති වස්තුවක් අනුක්‍රමණය කිරීම වඩා ආරක්ෂිතය. එවිට උද්ධෘත ලකුණු, හිස් අගයන් සහ විශේෂ අක්ෂර නිසා ඇතිවන දෝෂ අඩු වේ.

JSON ප්‍රතිචාර පරිවර්තනය

API ප්‍රතිචාරය සරල පෙළක් ලෙස පමණක් භාවිත කිරීම වෙනුවට එය VB.NET පන්තියකට පරිවර්තනය කළ හැකිය. System.Text.Json හෝ Newtonsoft.Json වැනි පුස්තකාලයක් මේ සඳහා භාවිත වේ. උදාහරණයක් ලෙස JSON තුළ id සහ title ක්ෂේත්‍ර තිබේ නම්, ඒවාට ගැළපෙන පන්ති ගුණාංග සකස් කරන්න.

Public Class Product
    Public Property id As Integer
    Public Property title As String
End Class

ප්‍රතිචාරය ලැබුණු පසු JsonSerializer.Deserialize(Of Product) භාවිතයෙන් වස්තුවක් සාදාගත හැකිය. සේවාදායකය ලැයිස්තුවක් ලබා දෙන්නේ නම් List(Of Product) වර්ගය යොදාගන්න. JSON ක්‍රම පිළිබඳ තවත් පසුබිම් දැනුමක් ලබාගැනීමට තාක්ෂණික ලිපි එකතුව වෙතද යොමුවිය හැකිය.

යතුරු, ශීර්ෂ සහ ආරක්ෂාව

බොහෝ API සේවා Authorization ශීර්ෂයක්, API යතුරක් හෝ ටෝකනයක් ඉල්ලා සිටියි. එය ඉල්ලීමකට එක් කිරීමේ ආකාරය සේවා ලේඛනය අනුව වෙනස් වේ.

client.DefaultRequestHeaders.Add("X-Api-Key", apiKey)

API යතුර කේතය තුළ සෘජුව ලිවීමෙන් වළකින්න. වින්‍යාස ගොනුවක්, පරිසර විචල්‍යයක් හෝ ආරක්ෂිත රහස් ගබඩාවක් භාවිත කිරීම සුදුසුය. සන්නිවේදනය සඳහා https ලිපින පමණක් භාවිත කර, සංවේදී දත්ත ලොග් ගොනු හෝ පණිවිඩ පෙට්ටි තුළ මුද්‍රණය නොකරන්න. ආරක්ෂිත වෙබ් භාවිත උපදෙස් කියවීමෙන් මෙවැනි අවදානම් පිළිබඳ අවබෝධය පුළුල් කරගත හැකිය.

දෝෂ පාලනය සහ පරීක්ෂණය

ජාලය විසන්ධි වීම, වැරදි API යතුර, කල් ඉකුත් වූ ඉල්ලීම, සීමා ඉක්මවා භාවිතය සහ වැරදි JSON ප්‍රතිචාරය වැනි තත්ත්ව සඳහා වැඩසටහන සූදානම් කළ යුතුය. HttpRequestException, TaskCanceledException සහ JSON පරිවර්තන දෝෂ වෙන් වෙන්ව හඳුනාගැනීමෙන් පරිශීලකයාට පැහැදිලි පණිවිඩයක් පෙන්විය හැකිය.

API සම්බන්ධතාව පරීක්ෂා කරන විට පළමුව Postman වැනි මෙවලමකින් ඉල්ලීම නිවැරදිදැයි බලන්න. ඉන්පසු VB.NET යෙදුම තුළ තත්ව කේතය, ප්‍රතිචාර ශීර්ෂ සහ ලැබෙන JSON අන්තර්ගතය පරීක්ෂා කරන්න. නැවත උත්සාහ කිරීම අවශ්‍ය නම් කෙටි ප්‍රමාදයක් සහ උපරිම උත්සාහ ගණනක් සකස් කර, සේවාදායකයට අනවශ්‍ය බරක් නොදෙන්න.

VB.NET ව්‍යාපෘතියක බාහිර API සම්බන්ධ කිරීමේදී මේ ක්‍රම අනුගමනය කරමින් කුඩා GET ඉල්ලීමකින් ආරම්භ කරන්න. පසුව JSON පරිවර්තනය, සත්‍යාපනය සහ දෝෂ පාලනය එක් කර ඔබේම ප්‍රායෝගික යෙදුමක් ගොඩනගන්න.