michelmelo/rest-api

dev-master 2024-09-05 14:26 UTC

This package is auto-updated.

Last update: 2024-09-05 14:26:45 UTC


README

Krayin REST API 是一个中间件,用于使用 Krayin 核心系统的功能。通过使用 Krayin REST API,您可以集成您的应用程序以提供 Krayin 的默认内容。

1. 要求

  • Krayin: v2.0.0

2. 安装

要从控制台安装 Krayin REST API

对于最新的 rest api 版本

composer require krayin/rest-api

将以下选项添加到您的 .env 文件中

SANCTUM_STATEFUL_DOMAINS="${APP_URL}"
L5_SWAGGER_UI_PERSIST_AUTHORIZATION=true

要使用 L5-Swagger 文档配置 REST API,请运行以下命令

php artisan krayin-rest-api:install

执行上述命令后,您将在 shell 中看到显示的 API 端点。

或者,您也可以通过在浏览器中访问以下 URL 来检查 API 文档

https:///public/api/admin/documentation
  • 您还可以查看有关配置 API 文档的 L5-Swagger 指南。