POSTMAN භාවිතයෙන් HTTP request handling.

Web හා සම්බන්ධ technologies පාවිච්චි කරනවානම් HTTP requests වල වැදගත්කම ගැන අමුතුවෙන් කියන්න ඕනෙ නෑනෙ.

මේ තරම් වැදගත් වෙන HTTP request තමයි අන්තර්ජාලය තුලදි website හෝ web based applications වලදි දත්ත හුවමාරුව සඳහා යොදාගන්නෙ. අපි සරලව එහෙම කියමු. නමුත් ඇත්තටම වෙන දේ මීට වඩා සංකීර්ණ ක්‍රියාදාමයක්. නමුත් මේ මට්ටමින් සලකා බැලුවම ප්‍රමාණවත්.

ඉතින් මේ කියන HTTP requests සමඟ ගනුදෙනු කරද්දි එහෙමත් නැත්නම් application එකක් develop කරද්දී request එකක ක්‍රියාවලිය ආදර්ශනය කරන්න අවශ්‍ය වෙනවා.

මේ සඳහා නිර්මාණය කරපු Tool එකක් තමයි මේ Postman කියන්නෙ.

ඉතින් මේ ලිපියෙන් අපි කතා කරන්නෙ Postman එක්ක කොහොමද වැඩ කරන්නෙ කියන එක ගැන.

අපි කියන්න යන දේට සරල ප්‍රවේශයක් ගමු.

හිතන්න අපි කුඩා web application එකක් නිර්මාණය කරනව server එකේ තියන database එකකින් user ඉල්ලපුවම දත්ත ලබා දෙන විදියෙ.

ඉතින් මේ application එකේ frontend එක සහ backend එක වෙන වෙනම develop කරනවනම් application එක develop කරද්දී request එක්ක ගනුදෙනු කරන්න හැකියාවක් නෑ.

ඒ මොකද කියනවනන් frontend එක, backend එක අතරෙ සම්බන්ධතාවක් තවමත් ගොඩනගාගෙන නැති නිසා. මේ වෙලාවෙදි තමයි අපිට Postman ඕනෙ වෙන්නෙ. Postman හරහා අපිට request එක HTTP request එකක් විදියට යවල බලන්න පුලුවන් අපි බලාපොරොත්තු වෙන result එක ලැබෙනවද කියල.

තවමත් මේ කියන දේ ගැන හරියටම අවබෝධයක් නෑ කියල මම දන්නව. ඒ නිසා කලබල වෙන්න අවශ්‍ය නෑ. ඉදිරියට යද්දි පැහැදිලි වෙයි.

මුලින්ම පොඩි කාලයක් වෙන් කරගමු HTTP request ගැන දැනගන්න.

HTTP request එකකට අදාල HTTP methods තමයි ප්‍රධානම දේ. එකිනෙකට වෙනස් කාර්යයන් ඉටු කරන HTTP methods කිහිපයක්ම අපිට හමු වෙනවා.

ඒවා අතරින් ප්‍රධාන කිහිපයක් ගැන අවබෝධයක් ලබා ගනිමු.

• GET : ලබා දුන් URI (Uniform Resource Locator) එකකට අදාලව දත්ත ලබා ගැනීමට (Retrieve) භාවිතා කරයි.

• HEAD : GET වලට සමාන method එකක්.

• POST : server එකට data යැවීම සඳහා භාවිතා කරයි.

• DELETE : target URI එකකට අදාලව දත්ත remove කිරීමට යොදාගනී.

මෙවැනිම method කිහිපයක්ම පවතිනව. ඒ ගැනත්සොයා බලන්න.

Postman tool එක API development environment එකක් විදියටත් හඳුන්වනවා. API කියන්නෙ application programming interface කියන එක. API එකක් කියන්නෙ යම් system එකක, application එකක, service එකකට අදාලව ඇති features හෝ දත්ත වලට පිවිසීම සඳහා භාවිත කරන functions හෝ procedure එකක් කියල සරලව කියන්න පුලුවන්.

ඉතින් Postman හරහා අපි deveop කරන API එකක් request හරහා test කරගන්නත් හැකියාව තියනවා.

මුලින්ම Postman tool එක Download කරල install කරගන්න. සරල පියවර කිහිපයකින් මේ දේ කරගන්න පුලුවන්. මේ link එකෙන් Postman download කරගන්න.

https://www.getpostman.com/

මේ රූපයෙන් දැක්වෙන්නෙ Postman tool එකේ අතුරු මුහුනත.

අපි මුලින්ම request එකක් යවල බලමු.

උදාහරණයක් විදියට GET request එකක් යවල data ටිකක් retrieve කරල බලමු. Request එකක් යැව්වම වෙන්නෙ ඊට අදාල function එකක් run වෙලා අවශ්‍ය කාර්‍යය සිදු කරල දෙන එක.

Postman testing වලට අදාල pre-defined request එකක් මුලින්ම යවල බලමු.

මුලින්ම postman-echo.com/get කියන එක URL field එකට දාල GET කියන method එක select කරගන්න.

දැන් “Send” button එක click කරන්න.

එවිට මේ විදියට JSON ආකාරයෙන් response එක display වෙයි.

මෙන්න මේ දේ තමයි request වලින් කරන්නෙ. Method type එක සහ URL එක වෙනස් කරල අපිට අවශ්‍ය request එක හදාගන්න පුලුවන්.

දැන් බලමු මේ output එක ලබා දෙන්න සිදු වෙන process එක මොකක්ද කියල.

පියවරෙන් පියවර මේ ක්‍රියාවලිය පැහැදිලි කරගමු.

1. postman tool එකට request details ඇතුලත් කරන්න. (URL: postman-echo.com/get) දැන් “send” button එක click කරන්න.

2. මීළඟට server එකට මේ යවපු request එක receive උනාට පස්සෙ ඊට අදාල code එකක් run වෙලා request කරපු response එක ලබා දෙනවා. බොහෝවිට මේ run වෙන code එක තියෙන්නෙ controller එකක් ඇතුලෙ. (MVC architecture) මේ ගැන ඉදිරියේදී කතා කරමු.

3. ලැබුන response එක interface එකේ display වෙනවා.

දැන් තේරුම් ගන්න පුලුවන් ඇති මේ වෙන දේ HTTP request සහ response මූලික කරගෙන වෙන දෙයක් කියන එක.

Request collection එකක් සාදා ගැනීම.

අපි භාවිතා කරන HTTP requests Postman tool එකේ වම්පසින් History කියන කොටසින් බලාගන්න පුලුවන්.

ඒ වගේම තමයි Requests collection එකක් task එකකට අදාලව හදාගන්න අවශ්‍යනම් request එක URL bar එකට ඇතුලත් කරල “Send” button එක ලඟ තියෙන “Save” button එක click කරන්න.

එවිට පහත පරිදි popup window එකක් ලැබේවි.

ඊට අදාල field ටික fill කරල “save” කරගන්න.

එවිට වම්පසින් ඇති “collection” tab එකට ගියාම එම request collections බලාගන්න පුලුවන්.

HTTP request එකක් මගින් Controller එකක ඇති function එකක් run කිරීම.

MVC architecture එකත් එක්ක වැඩ කරන විට අපිට controllers හමු වෙනව. Program එකට අදාලව functions ටික වෙන්නෙ මේ කියන controllers වලින්. ඒ කියන්නෙ model එකෙන් data retrieve කරගෙන view එකේ display කරන කොටස සිදුවන්නේ controllers ඇතුලෙදි.

අපි මේක sample code එකක් මගින් පැහැදිලි කරගමු.

මම මේ code එක ලියල තියෙන්නෙ PHP framework එකක් වන Yii framework එකෙන්. නමුත් ඒක අදාල නෑ. මේ ගැන අවබෝධයක් ලබාගන්න විතරයි අවශ්‍ය.

අපි “TaxiController.php” කියන controller එකේ තියන “actionGetTaxi” කියන function එකේ තමයි code එක ලියල තියෙන්නෙ.

පහතින් දැක්වෙන්නෙ ඒ code එක.

මේ code එකේ පේනව ඇති “GET” කියන keyword එක. ඉතින් හිතාගන්න පුලුවන් නේද මේක GET request එකක් handle කරන්න පාවිච්චි කරයි කියල.

කලින් කතා කලා වගේ GET request එකකින් කරන්නෙ data retrieve කරන එක. එහෙනම් මෙතනදිත් අනිවාර්යයෙන් ඒ දේම තමයි වෙනව ඇත්තෙ.

ඇත්තටම කියනවනන් මේ code එකෙන් වෙන්නෙ එහෙම දෙයක් තමයි. සරලව පැහැදිලි කලොත් මෙතනදි වෙන්නෙ controller එකේ තියන මේ function එක GET method එකක් එක්ක call කලොත් Taxi කියන model එකෙන් database එකේ තියන සියලු දත්ත retrieve කරල දෙනව.

ඒක අවසානයේදී JSON object එකක් විදියට return කරල තියනව.

සරලම කතාව table එකෙන් data අරගෙන retrieve කරනව.

මේ දේ තමයි code එකට අදාලව සිදු වෙන්නෙ.

දැන් අපි බලමු request එක call කරන්නෙ කොහොමද කියල.

Postman tool එකේ URL bar එකේ තමයි request URL එක type කරන්නෙ. මේකෙත් කොටස් කිහිපයක්ම තියනව. අපි ඒ ගැනත් කතා කරමු.

"http://localhost/backend_FAQ/scapp/taxi/getTaxi"

මේ තියෙන්නෙ අපේ program එකට අදාල request URL එක. GET කියන method එක තමයි use කරල තියෙන්නෙ.

අපි URL එකේ කොටස් ටික හඳුනා ගනිමු.

1. මේ කොටසින් controllers අඩංගු folder එකට අදාල path එක පෙන්නනව.

2. http://localhost/backend_FAQ/scapp/

3. “taxi” කියන text එකෙන් controller එක නිරූපණය කරනව. Controller එකේ නිවැරැදි නම “TaxiController.php” උනත් මෙතනදි ලබා දෙන්නෙ “taxi” කියල විතරයි. එවිට ඒක controller එකක් විදියට හඳුනා ගන්නව.

4. “getTaxi” කියන්නෙ Taxi controller එකේ තියන function එක. ඉතින් මේ කොටස් ටික URL එක විදියට දුන්නම අදාල controller එකේ අදාල method එක run වෙනව.

http://localhost/backend_FAQ/scapp/taxi/getTaxi

මේ URL එකට අදාලව ලැබෙන response එක මේ විදියට බලාගන්න පුලුවන්.

මේ ආකාරයටම POST method එක use කරල server එකට data යවන්නත් පුලුවන්.

මේ තියෙන්නෙ ඒකට උදාහරණයක්.

"http://localhost/backend_FAQ/scapp/vote/updateVote?id=111&freeAns=test answer 4&mobile=+5842255245"

URL bar එක ලඟම තියන “Param” කියන එකෙන් අපිට අදාල parameters ලබා දෙන්න පුලුවන්. ඒ වගේම තමයි ඒ විදියට pass කරන parameter ලබා ගන්න පුලුවන් ආකාරයට controllers වල function තියෙන්නත් අවශ්‍ය වෙනව.

මේ තියෙන්නෙ parameters pass කරල තියන ආකාරය.

අපිට අවශ්‍ය parameters පමණක් ලබා දීල අනවශ්‍ය parameters disable කරන්නත් හැකියාව ලබා දීල තියනව.

මේ විදියට JSON object පවා request එකක් ආකාරයට යවන්න හැකියාවක් postman tool එකෙන් ලබා දීල තියනව.

අපි Postman tool එකේ ඉතා කුඩා කොටසක් තමයි මේ කතාකලේ. ඉතින් කිසිම අවබෝධයක් නැතුව හිටපු අයෙකුට සුලු හෝ දැනුමක් ලැබෙන්න ඇති කියල හිතනව. Developer කෙනෙක්නම් මේ දේවල් අනිවාර්යයෙන් දැනගෙන ඉන්න අවශ්‍යයි.

ඉතින් තියන ඕනෙම ගැටලුවක් comment කරන්න, නැත්නම් e-mail කරන්න.

තවත් මේ වගේ ලිපියකින් හමු වෙමු.

මූලාශ්‍ර :

https://www.tutorialspoint.com/http/http_requests.htm

https://www.getpostman.com/docs/postman/launching_postman/sending_the_first_request

https://www.getpostman.com/docs/postman/launching_postman/creating_the_first_collection

https://www.getpostman.com/docs/postman/launching_postman/navigating_postman

#postman #httprequests #httprequesthandling #GETmethod #POSTmethod #APIdevelopmentenvironment #controllers