renegare/weblet-platform

Silex Weblet Platform/API OAuth2 应用

v0.0.0 2014-08-29 15:41 UTC

This package is not auto-updated.

Last update: 2024-09-24 01:07:17 UTC


README

Build Status

本项目包含一组基础类,可用于创建 API 应用程序。这是一个库,应将其作为依赖项包含并扩展以满足您的需求。

真正的基座是 Silex*,本质上是一个预配置的 Silex 应用程序。目标是提供尽可能低的入门曲线。

但是,不要让这限制了您项目的雄心;)

本库的目标是提供以下功能

  • OAuth2 兼容的服务器
  • 端点服务定位器
  • 类似 Swagger 的文档生成

(此列表并不完整,根据需求将不断增长)

* 使用 Silex v1.2.x(一旦稳定,将升级到 2.0)

文档...

...目前不存在。然而,每个功能至少有一个测试。如果它们太复杂而难以阅读,那么我可能需要重写它们。但不要害怕。当我有时间时,文档将成为优先事项!

使用方法

要使用此库,请通过 composer 将其作为依赖项包含到您的项目中

composer require renegare\weblet-base:dev-master

(!!!请使用实际标记的版本进行生产使用,因为 dev-master 可能会未经通知进行更新并包含错误。!!!)

然后创建一个实例或扩展类 \Renegare\Weblet\Platform\Weblet

// Example index.php

/**
 * Pass the app name and configuration to the constructor
 * - No errors are thrown if any yaml file does not exist
 */
$app = new Renegare\Weblet\Platform\Weblet('weblet',
    __DIR__ . '/../app-constants.yml.dist',
    __DIR__ . '/../app-constants.yml',
    ['app.root' => dirname(__DIR__)] // required
);

// enable built in functionality
$app->enableSecurity();
$app->enableLogging();

// and away we go!
$app->run();

测试

composer test

许可协议

MIT 许可证 (MIT)

版权所有 (c) 2014 Renegare

特此授予任何获得此软件及其相关文档副本(以下简称“软件”)的人,在不受限制的情况下使用软件的权利,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利,并允许向软件提供的人这样做,前提是遵守以下条件

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

软件按“原样”提供,不提供任何明示或暗示的保证,包括但不限于适销性、特定用途适用性和非侵权性保证。在任何情况下,作者或版权所有者均不对任何索赔、损害或其他责任承担责任,无论是在合同、侵权或其他责任,均源自、因或与软件或软件的使用或其他方式有关。