thazh/api-light

这是一个轻量级库,用于在PHP中构建安全的REST API。

1.0.0 2024-05-17 17:54 UTC

This package is auto-updated.

Last update: 2024-09-18 08:20:59 UTC


README

这是一个轻量级库,用于在PHP中构建安全的REST API。

功能

该库提供的主要功能包括:

  • 易于使用
  • 支持所有PHP版本
  • 字段验证
  • 基本认证
  • 支持多种内容类型
  • 支持所有请求方法

快速开始

使用composer安装库

composer require thazh/api-light

一个示例PHP API,用于验证和处理输入数据并打印响应数据

<?php

use Thazh\ApiLight\RestApi;

$options = array(
    'content_type' => 'application/json',
    'request_method' => 'POST',
    'credentials' => array(
        'testuser' => 'TestPwd@123',
    ),
    'required_fields' => array(
        'rollno',
        'name',
    )
);

$obj = new RestApi($options);

/* Custom business logic */
$output_data = "Hi, " . $obj->request['name'] . "! Your roll no is " . $obj->request['rollno'];

/* Set code 200 for the success response */
$obj->code = 200;

/* Set API response data */
$obj->data = $output_data;

/* Print the API response data */
$obj->print();

POST参数

{
    "rollno": 10001,
    "name": "Saravanan S"
}

上述示例PHP API输出以下响应

{
    "code": 200,
    "status": "success",
    "data": "Hi, Saravanan S! Your roll no is 10001"
}