REST API client នេះអនុញ្ញាតឲ្យអ្នកតេស្ត API ដោយមិនបាច់ដំឡើង Postman ឬ Insomnia ឡើយ។ ជ្រើសរើស method, បិទភ្ជាប់ URL, បន្ថែម query parameters, headers និង body ជា JSON, អត្ថបទ ឬ form, ជ្រើសរើស Bearer ឬ Basic authentication រួចចុច Send។ អ្នកនឹងឃើញ status code, រយៈពេល request, ទំហំ response, គ្រប់ response header និង body ដោយមាន JSON pretty-printed និងបែងចែកពណ៌យ៉ាងច្បាស់។
Request ត្រូវបានផ្ញើចេញពី browser របស់អ្នកទៅកាន់ API ដោយផ្ទាល់ ដូច្នេះគ្មានអ្វីឆ្លងកាត់ server របស់ ToolOrca ឡើយ ហើយ token របស់អ្នកនៅតែមានសុវត្ថិភាពលើឧបករណ៍របស់អ្នក។ Request ថ្មីៗត្រូវបានរក្សាទុកក្នុងប្រវត្តិ (history) នៃ browser នេះ ដូច្នេះអ្នកអាចដំណើរការឡើងវិញបាន ហើយចុចតែម្តងដើម្បីចម្លង request ណាមួយជាពាក្យបញ្ជា curl ឬកូដ JavaScript fetch()។ Presets សម្រាប់ ToolOrca sample API ឥតគិតថ្លៃ អនុញ្ញាតឲ្យអ្នកសាកល្បងបានភ្លាមៗ។
របៀបប្រើឧបករណ៍ ឧបករណ៍ REST API Client
- ជ្រើសរើស HTTP method (GET, POST, PUT, PATCH, DELETE, HEAD ឬ OPTIONS) រួចបញ្ចូល URL នៃ request ឬជ្រើសរើស preset ពី ToolOrca sample API។
- បន្ថែម query parameters និង headers ក្នុងតារាង។ ដោះធីកជួរដេកណាមួយដើម្បីកុំប្រើវាដោយមិនបាច់លុប។
- សម្រាប់ POST, PUT និង PATCH សូមជ្រើសរើសប្រភេទ body (JSON, text ឬ form) រួចសរសេរ body។ Format JSON ជួយរៀបចំឲ្យមានរបៀប និងពិនិត្យភាពត្រឹមត្រូវ។
- នៅក្រោម Auth សូមជ្រើសរើស Bearer token ឬ Basic (ឈ្មោះអ្នកប្រើ និងពាក្យសម្ងាត់) ប្រសិនបើ API ទាមទារ។
- ចុច Send (ឬ Ctrl+Enter)។ ពិនិត្យ status, រយៈពេល, ទំហំ, headers និង body រួចចម្លង response ឬ request ជា curl ឬ fetch។
ហេតុអ្វីប្រើ ឧបករណ៍ REST API Client របស់ ToolOrca
- គ្រប់ method ទូទៅ៖ GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS
- កែសម្រួល query parameter និង header ជាមួយប៊ូតុងបិទ/បើក
- Body ជា JSON, អត្ថបទធម្មតា និង form-urlencoded
- ការផ្ទៀងផ្ទាត់ Bearer token និង Basic auth
- Status, រយៈពេល response, ទំហំ និង headers ទាំងអស់
- បង្ហាញ JSON យ៉ាងមានរបៀប និងមានពណ៌សម្គាល់
- ចម្លងជា curl ឬ fetch និងមានប្រវត្តិ request ក្នុង browser របស់អ្នក
- ដំណើរការលើទូរស័ព្ទ និងកុំព្យូទ័រ
មូលហេតុដែល API មួយចំនួនបរាជ័យនៅទីនេះ៖ CORS
ទំព័រវេបសាយអាចអាន response ពី domain ផ្សេងបាន លុះត្រាតែ server នោះអនុញ្ញាតតាមរយៈ header Access-Control-Allow-Origin (CORS)។ Public API ជាច្រើនបានបើកវា ហើយគ្រប់ endpoint របស់ ToolOrca sample API ក៏ដូចគ្នាដែរ។ Private API និង backend ក្រុមហ៊ុនជាច្រើនមិនបានបើកទេ ហេតុនេះ browser នឹងទប់ស្កាត់ response ហើយ client បង្ហាញ network error ទោះបីជា request ដដែលនោះដំណើរការលើ curl ឬកម្មវិធីទូរស័ព្ទក៏ដោយ។
ប្រសិនបើជួបបញ្ហានេះ សូមប្រើ Copy as curl ហើយដំណើរការ request ក្នុង terminal ឬស្នើសុំម្ចាស់ API ឲ្យអនុញ្ញាត origin របស់អ្នក។ Browser ក៏លាក់ response headers មួយចំនួនផងដែរ លុះត្រាតែ server បញ្ជាក់ពួកវាក្នុង Access-Control-Expose-Headers និងហាមឃាត់ការកំណត់ headers មួយចំនួនដូចជា Cookie, Host និង Origin។
ស្វែងយល់ពី HTTP status codes
2xx មានន័យថាជោគជ័យ៖ 200 OK, 201 Created បន្ទាប់ពី POST, 204 No Content បន្ទាប់ពី DELETE ជាច្រើន។ 3xx គឺជា redirect ដែល browser នឹងរត់តាមដោយស្វ័យប្រវត្តិ។ 4xx មានន័យថា request មានបញ្ហា៖ 400 input មិនត្រឹមត្រូវ, 401 មិនទាន់ login ឬ login មិនត្រឹមត្រូវ, 403 គ្មានសិទ្ធិ, 404 រកមិនឃើញ, 422 validation បរាជ័យ, 429 ស្នើសុំច្រើនពេក។ 5xx មានន័យថា server មានបញ្ហា។
ប្រើប្រាស់ HTTP Testing API ដើម្បីសាកល្បង status នីមួយៗតាមចិត្តចង់៖ /api/v1/status/404, /api/v1/delay/3 សម្រាប់ response យឺត និង /api/v1/echo ដើម្បីមើលទិន្នន័យជាក់ស្តែងដែល request របស់អ្នកបានផ្ញើ។
សំណួរដែលសួរញឹកញាប់
តើនេះជាជម្រើសជំនួស Postman លើអនឡាញមែនទេ?
សម្រាប់ការតេស្តប្រចាំថ្ងៃគឺពិតជាមែន៖ មាន methods, params, headers, bodies, auth, history និងចម្លងជា curl។ វាដំណើរការក្នុង browser របស់អ្នកដោយមិនបាច់ដំឡើង ឬបង្កើតគណនីទេ។ សម្រាប់ការគ្រប់គ្រងជាក្រុម និង automated test កម្មវិធី desktop នៅតែល្អជាង។
Why do I get "Failed to fetch" or a network error?
ជាទូទៅមកពី CORS៖ API មិនអនុញ្ញាត request ពីគេហទំព័រលើ domain ផ្សេង។ វាក៏អាចបណ្តាលមកពី URL ខុស, server គាំង ឬអ្នកបានហៅ http:// API ពីទំព័រ HTTPS នេះ (mixed content)។ សាកល្បងដំណើរការ request ជាមួយ curl ដើម្បីប្រៀបធៀប។
Are my tokens and requests sent to ToolOrca?
ទេ មិនផ្ញើទេ។ Request ត្រូវបានផ្ញើផ្ទាល់ពី browser របស់អ្នកទៅកាន់ URL ដែលអ្នកបញ្ចូល។ ប្រវត្តិត្រូវបានរក្សាទុកតែក្នុង local storage នៃ browser របស់អ្នកប៉ុណ្ណោះ ហើយអ្នកអាចលុបវាចេញបានគ្រប់ពេល។
Can I test APIs on localhost?
បាន ប្រសិនបើ local server របស់អ្នកអនុញ្ញាត CORS ពីគេហទំព័រនេះ។ Browser អនុញ្ញាតឲ្យហៅចេញពីទំព័រ HTTPS ទៅកាន់ http://localhost ប៉ុន្តែ server របស់អ្នកត្រូវតែផ្ញើ CORS headers មកវិញ។
Is there an API I can practise with?
មាន៖ ToolOrca sample API ឥតគិតថ្លៃ មានទិន្នន័យគំរូដូចជា ផលិតផល, អ្នកប្រើប្រាស់, ការបង្ហោះ, todos និងការ login ព្រមទាំងវចនានុក្រមខ្មែរ និងប្រតិទិនខ្មែរ។ ជ្រើសរើសមួយពីម៉ឺនុយ presets។