thitruongsicom/dingo-api

为Laravel和Lumen框架提供的RESTful API包。

v1.0.0 2023-02-20 08:58 UTC

This package is auto-updated.

Last update: 2024-09-20 12:19:48 UTC


README

注意:这是一个由该项目的维护者之一发起的官方且维护合理的https://github.com/dingo/api 仓库分支。分支的原因是由于与CI工具(如travis)的集成出现故障(只能由所有者修复),以及总体上为了更好地支持项目并确保更新不会破坏现有功能。

为了转移到此仓库,您只需更新您的composer文件。所有命名空间和项目的其他方面都保持不变。以下是一个示例,用于使用最新版本:

composer remove dingo/api
composer require api-ecosystem-for-laravel/dingo-api

请注意,我们不会积极维护此项目的Lumen支持。如果您仍在使用Lumen,我们建议您迁移到Laravel。

Dingo API包旨在为您提供一套工具,帮助您轻松快速地构建自己的API。虽然此包的目标是尽可能地保持灵活性,但它仍然无法涵盖所有情况并解决所有问题。

Build Status License Development Version Monthly Installs StyleCI

特性

此包提供以下工具,以及更多:

  • 内容协商
  • 多个身份验证适配器
  • API版本控制
  • 速率限制
  • 响应转换器和格式化器
  • 错误和异常处理
  • 内部请求
  • API蓝图文档

文档

有关更多信息,请参阅我们的详细Wiki文档

API模板

如果您想从头开始创建一个新项目,请考虑使用Laravel API模板,它在dingo-api包的基础上构建,并添加了许多优秀功能。

支持

如果您在Wiki中找不到答案,请避免发布问题。您可以在专门的Slack聊天室中寻求支持。请确保提及specialtactics以便他收到通知。

许可

此包根据BSD 3-Clause许可授权。