sibers/sibers-api

Sibers API 框架

安装: 11

依赖: 0

建议: 0

安全性: 0

星标: 3

关注者: 2

分支: 0

开放问题: 0

类型:项目

This package is not auto-updated.

Last update: 2024-10-02 03:43:33 UTC


README

Sibers API

Sibers API(基于API Platform)是一个下一代Web框架,旨在轻松创建API优先的项目,同时不牺牲可扩展性和灵活性。

  • 设计您自己的数据模型为普通的PHP类,或从Schema.org词汇表中导入现有的一个。
  • 在几分钟内公开超媒体REST API,具有分页、数据验证、访问控制、关系嵌入、筛选和错误处理...
  • 利用内容协商:内置支持JSON-LDHydraHALYAMLJSONXMLCSV
  • 享受自动生成的精美API文档(Swagger/OpenAPI)。
  • 通过React添加一个方便的Material Design管理界面,无需编写代码。
  • 通过CRUD生成器,使用React、Redux、React Router和Bootstrap快速搭建一个完整的单页面应用。
  • 使用Docker安装开发环境,并在生产环境中部署项目。
  • 轻松添加JSON Web Token或OAuth身份验证。
  • 使用基于Behat的API测试工具创建规范和测试。

Sibers API拥抱开放Web标准(Swagger、JSON-LD、Hydra、HAL、JWT、OAuth、HTTP...)和关联数据运动。您的API将自动在Schema.org/JSON-LD中公开结构化数据。这意味着您的API平台应用程序可以与语义网技术无缝使用。

这也意味着您的SEO将得到提升,因为Google利用这些格式

最后但同样重要的是,Sibers API建立在Symfony框架之上。这意味着您可以使用

  • API Platform与数千个Symfony捆绑包一起使用。
  • 将API Platform集成到任何现有的Symfony应用程序中。
  • 重用您的所有Symfony技能,并从大量Symfony文档中获益。
  • 享受流行的 Doctrine ORM (默认使用,但完全可选:您可以使用您想用的数据提供者,包括但不限于MongoDB ODM和ElasticSearch)

安装

运行 composer require sibers/sibers-api-bundle。安装后需要生成SSH密钥。

$ mkdir -p var/jwt # 对于Symfony3+,不需要-p选项
$ openssl genrsa -out var/jwt/private.pem -aes256 4096
$ openssl rsa -pubout -in var/jwt/private.pem -out var/jwt/public.pem

配置您的参数文件parameters.yml

jwt_private_key_path: '%kernel.root_dir%/../var/jwt/private.pem' # ssh私钥路径
jwt_public_key_path: '%kernel.root_dir%/../var/jwt/public.pem' # ssh公钥路径
jwt_key_pass_phrase: '' # ssh密钥密码短语
jwt_token_ttl: 3600

鸣谢

由Alexander Gordeychik创建。