koldown / httproute
这是一个库,使我们能够以简单快捷的方式配置在Laravel中创建的Web Services API的访问(端点)
1.0.0
2019-12-26 16:42 UTC
This package is not auto-updated.
Last update: 2024-09-27 15:25:12 UTC
README
这是一个库,使我们能够以简单快捷的方式配置在Laravel中创建的API Services的访问(端点)。
安装
composer require koldown/httproute
使用方法
首先,我们必须在Controller
中设置API Services请求要使用的函数,并在文档部分添加以下内容:
class PhotosController extends Controller {
/**
*
* #Http(POST)
* #Route(photos)
*/
public function store() {
// Definir los procesos a realizar en la solicitud
}
/**
*
* #Http(GET)
* #Route(photos)
*/
public function index() {
// Definir los procesos a realizar en la solicitud
}
/**
*
* #Http(GET)
* #Route(photos\{id})
*/
public function record(Request $request) {
// Definir los procesos a realizar en la solicitud
}
/**
*
* #Http(PUT)
* #Route(photos\{id})
*/
public function update() {
// Definir los procesos a realizar en la solicitud
}
/**
*
* #Http(DELETE)
* #Route(photos\{id})
*/
public function destroy() {
// Definir los procesos a realizar en la solicitud
}
}
完成后,我们将进入项目配置API路由的Laravel文件,并添加以下代码:
\Koldown\HttpRoute\RouteBuilder::getInstance()->readerController(PhotosController::class);
readerController
函数位于\Koldown\HttpRoute\RouteBuilder
类中,它接收一个Controller
类作为参数,遍历其公共方法,如果在这些方法的文档部分找到库的注释,将自动生成项目的API Services路由。
注释
#Http
设置访问API Service将使用的HTTP方法。可能的值为 POST、GET、PUT、DELETE。
#Route
设置访问API Service的URL模式。