anax/remserver

Anax remserver模块。

v2.1.5 2020-11-09 23:44 UTC

This package is auto-updated.

Last update: 2024-09-10 08:26:36 UTC


README

Latest Stable Version Join the chat at https://gitter.im/canax/remserver

Build Status CircleCI

Build Status Scrutinizer Code Quality Code Coverage

Maintainability Codacy Badge

Anax REM服务器(remserver)模块实现了一个REM服务器。REM服务器是一种REST Mockup API,用于开发REST客户端的测试和开发。

您可以使用此模块与Anax安装一起使用,以快速搭建REM服务器,这对于测试、开发和原型制作非常有用。

此remserver可以使用各种HTTP方法在预定义的数据集中执行CRUD操作。您可以通过配置添加并供应自己的JSON数据集。

数据存储在会话中,因此不能在用户和浏览器之间共享。

将REM服务器用作网络服务

此模块与Anax网站一起打包在存储库"Anax REM服务器网站"中,该网站托管在https://rem.dbwebb.se

在那里,您可以阅读有关如何使用REM服务和尝试它的文档。

作为Anax模块安装

以下是将模块安装到现有Anax安装中的方法,例如[anax/anax](https://github.com/canax/anax)的安装。

安装过程有两个步骤,1)首先使用composer安装模块,然后2)将其集成到您的Anax基本安装中。

步骤1,使用composer安装

使用composer安装模块。

composer require anax/remserver

步骤2,集成到您的Anax基本

您可以在vendor/anax/remserver/config目录中查看模块配置文件。它包括以下部分。

您可以使用以下命令复制所有模块配置文件。

# Go to the root of your Anax base repo
rsync -av vendor/anax/remserver/config ./

现在remserver在remserver/路由上激活。您可以在remserver/users路由上尝试它以获取默认数据集users

可选地,您可以复制API文档作为Markdown内容。仅在您支持从content/目录的Flat File Content时执行此操作。

rsync -av vendor/anax/remserver/content/index.md content/remserver-api.md

现在API文档通过remserver-api路由可用。

现在您可以将REM服务器模块用作Anax安装的集成部分。

依赖关系

这是一个Anax模块,其使用主要是为了与Anax框架一起使用。

您可以在anax/anax上安装一个实例,并在其中运行此模块以进行测试和开发。

存储库"Anax REM服务器网站"是展示如何做到这一点的示例。