api response
v1.2.2
ลักษณะการตอบสนอง JSON ของ CoreJsonResponse ลักษณะนี้ทำให้ตัวควบคุมสามารถส่งคืนการตอบสนอง JSON ด้วยรหัสสถานะ HTTP ที่เหมาะสมได้อย่างง่ายดาย
composer require aelnemr/api-response
สิ่งที่คุณต้องมีคือ use
คุณลักษณะ CoreJsonResponse
ภายในคอนโทรลเลอร์ของคุณ
ตัวอย่าง:
<?php
namespace App Http Controllers ;
use Illuminate Http Request ;
use AElnemr RestFullResponse CoreJsonResponse ;
class CountryController extends Controller
{
use CoreJsonResponse;
public function index ()
{
$ data = App User:: get ();
return $ this -> ok ( $ data );
}
}
วิธี | รหัสสถานะ | คำอธิบาย |
---|---|---|
ตกลง | 200 | รับแพทช์สำเร็จ (ส่งคืนออบเจ็กต์ JSON) |
ตกลงด้วยการแบ่งหน้า | 200 | รับแพทช์สำเร็จ (ส่งคืนออบเจ็กต์ JSON) |
สร้าง | 201 | โพสต์สำเร็จ (ส่งคืนออบเจ็กต์ JSON) |
วิธี | รหัสสถานะ | คำอธิบาย |
---|---|---|
ไม่ผ่านการรับรองความถูกต้อง | 401 | เกิดข้อผิดพลาดไม่ได้รับการรับรองความถูกต้อง |
ต้องห้าม | 403 | เกิดข้อผิดพลาดไม่ได้รับอนุญาต (ตรวจสอบสิทธิ์แล้ว แต่ไม่มีการอนุญาต) |
ไม่พบ | 404 | ไม่พบข้อผิดพลาด |
คำขอไม่ถูกต้อง | 422 | การตรวจสอบข้อผิดพลาด |
วิธี | รหัสสถานะ | คำอธิบาย |
---|---|---|
ได้รับการยอมรับ | 202 | โพสต์สำเร็จ ลบ เส้นทาง - อะซิงโครนัส |
คำขอที่ไม่ดี | 400 | ข้อผิดพลาด เซิร์ฟเวอร์ไม่สามารถเข้าใจคำขอได้เนื่องจากไวยากรณ์มีรูปแบบไม่ถูกต้อง |
การชำระเงินที่จำเป็น | 402 | เกิดข้อผิดพลาด จำเป็นต้องชำระเงิน |
ขัดแย้ง | 409 | ข้อผิดพลาด ข้อผิดพลาดทางลอจิก |