README

存档仓库
此代码不再维护。欢迎fork它，但请自行承担风险。

Marmelab Microrest

Microrest是一个Silex提供者，用于基于YAML（RAML）配置文件在关系数据库上设置REST API。

查看发布文章。

什么是RAML？

RESTful API Modeling Language (RAML)是一种简单简洁的描述实际RESTful API的方法。它鼓励重用，促进发现和模式共享，并旨在基于业绩产生最佳实践。

您可以从API Designer轻松设置RAML文件。

安装

要安装microrest.php库，请运行以下命令并获取最新版本

composer require marmelab/microrest "~1.0@dev"

在您的应用程序中启用ServiceController、Doctrine和Microrest服务提供者

$app->register(new Silex\Provider\ServiceControllerServiceProvider());
$app->register(new Silex\Provider\DoctrineServiceProvider(), array(
    'db.options' => array(
        'driver'   => 'pdo_sqlite',
        'path'     => __DIR__.'/app.db',
    ),
));
$app->register(new Marmelab\Microrest\MicrorestServiceProvider(), array(
    'microrest.config_file' => __DIR__ . '/api.raml',
));

您需要提供描述您的API的RAML文件的路径。您可以在tests/fixtures目录中找到一个示例。

然后，在您的RAML api文件的baseUrl配置中定义的URL上浏览您的新API REST。

测试

使用以下命令运行测试套件

make install
make test

演示

您可以在examples/ng-admin中找到一个完整的演示应用程序。您只需要运行2个命令来安装和运行它

make install-demo
make run-demo

在URL：http://localhost:8888/api上玩Silex演示API

使用URL：http://localhost:8888/admin上的ng-admin后端管理来探索API

许可证

microrest.php在MIT许可证下发布，由marmelab提供。

marmelab / microrest

维护者

详细信息

README

Marmelab Microrest

什么是RAML？

安装

测试

演示

许可证