Skip to content

yiapi 是什么?

中文名称 易接口

一个注重效率和速度的 Node.js 接口开发框架,不做大而全,只做小部分开发者的小而美。

功能特点

  • ✅ 只需 简单配置,即可快速上手开发。
  • ✅ 默认支持 微信扫码 登录注册功能,解决垃圾账号和短信费用问题。
  • ✅ 自动生成 接口文档,方便前后端对接。
  • ✅ 自带 权限角色管理日志菜单接口字典 等基础功能。
  • ✅ 自带 邮件发送文件上传 等功能。
  • ✅ 自带 日志打印日志分割 功能。
  • ✅ 自带 jwt 鉴权机制。
  • ✅ 自带 在线人数统计踢人拉黑 等功能。
  • ✅ 自带 登录日志邮件日志 等功能。
  • ✅ 自带 微信支付 功能,支持 多产品折扣优惠
  • ✅ 自带配套的后台管理系统 yiadmin,30 分钟搭建一个后台管理系统。
  • ✅ 默认已处理 跨域 问题,无需再为跨域担心。
  • ✅ 优先使用 缓存,提高应用性能。
  • ✅ 默认提供 静态文件托管 功能。
  • ✅ 支持 定时任务 功能。
  • ✅ 可以 一键更新 后台管理系统。
  • ✅ 全面的 接口参数验证 功能,极大减少安全隐患。
  • ✅ 提供 数据库表字段设计表结构同步 功能。

功能限制

本框架做了很多约束,减少自由度,增加确定度,稳定度。

  • ❎ 仅支持 单机部署,使用 pm2 管理。
  • ❎ 仅支持 单角色权限
  • ❎ 仅支持 Mysql 关系数据库。
  • ❎ 仅支持 Redis 缓存数据库。
  • ❎ 仅支持 POSTGET 请求方法。
  • ❎ 仅支持 整数浮点数文本字符串 这四种数据库字段类型。
  • ❎ 不支持 分库分表
  • ❎ 不支持 Docker 部署,请自行研究。
  • ❎ 不支持 分布式部署
  • ❎ 不支持 Restful 规范,不认同 Restful 规范,不使用 Restful 规范。

注意事项

  • 与本项目逻辑、BUG、建议相关的问题,请联系作者无偿 免费处理
  • 与本项目无关的业务、功能、需求、部署相关的问题,请联系作者 有偿咨询

仓库地址

如果你觉得本项目不错,请不要吝啬,点个 star 吧~

gitee - https://gitee.com/yicode-team/yicode

github - https://github.com/chenbimo/yicode

作者简介

属性
姓名陈随易
微信chensuiyime
邮箱bimostyle@qq.com
知乎知乎陈随易
掘金掘金陈随易
码云码云陈随易
githubgithub 陈随易
交流探讨创建了 全球顶级程序员微信交流群,加入交流请加我微信

实际效果

使用 yiapi + yiadmin 驱动的,免费且开源的后台管理系统。

📄 登录页面

picture 0

📄 菜单页面

picture 2

📄 接口页面

picture 3

📄 角色页面

picture 4

📄 登录日志

picture 5

📄 邮件日志

picture 6

版权说明

yiapi(易接口) 使用 Apache 2.0 协议开源。

开源不等于放弃版权,不可侵犯原作者版权,改动处要做说明,可以闭源使用。

本仓库中所有项目均可免费使用,如果因本仓库任何项目产生的损失,仓库作者概不负责。

拥有版权 (Copyright) 意味着你对你开发的软件及其源代码拥有著作权,所有权和其他法定权利,使用一个开源协议并不意味着放弃版权。

Apache 2.0 协议许可下,您可以:

  • 商业化使用 (这意味着,您可以出于商业目的使用这些源代码)
  • 再分发 (这意味着,您可以将源代码副本传输给其他任何人)
  • 修改 (这意味着,您可以修改源代码)
  • 专利使用 (这意味着,版权人明确声明授予您专利使用权)
  • 私人使用 (这意味着,您可以出于一切目的私下使用和修改源代码)

唯须遵守以下条款:

  • 协议和版权通知 (这意味着,软件中必须包含许可证和版权声明的副本)
  • 状态更改说明 (如果您更改软件,您应当提供适当的说明)

除此之外,该软件:

  • 提供责任限制 (版权人声明不对使用者造成的任何损失负责)
  • 限制商标使用 (不能使用版权人的商标)
  • 不提供任何担保 (版权人声明不为该软件的品质提供任何担保)

进一步说明:

  1. 本软件又叫本作品,可以是源码,也可以是编译或转换后的其他形式。衍生作品是在本作品的基础上修改后的有原创性的工作成果。本作品的贡献者包括许可人和其他提交了贡献的人,以下统称

  2. 我授予你权利:你可以免费复制、使用、修改、再许可、分发本作品及衍生作品 (可以不用公开源码)。

  3. 如果本软件涉及我的专利 (或潜在专利),我在此授予你专利许可,你可以永久性地免费使用此专利,用于制作、使用、出售、转让本作品。如果你哪天居然告本作品侵权,你的专利许可在你告我那天被收回。

  4. 你在复制和分发本作品或衍生作品时,要满足以下条件。

    • 带一份本许可证。
    • 如果你修改了什么,要在改动的文件中有明显的修改声明。
    • 如果你以源码形式分发,你必须保留本作品的版权、专利、商标和归属声明。
    • 如果本作品带了 NOTICE 文件,你就得带上 NOTICE 文件中包含的归属声明。即便你的发布是不带源码的,你也得带上此文件,并在作品某处予以展示。
    • 你可以对自己的修改添加版权说明。对于你的修改或者整个衍生作品,你可以使用不同的许可,但你对本作品的使用、复制和分发等,必须符合本许可证规定。
  5. 你提交贡献就表明你默认遵守本许可的条款和条件。当然,你可以和我签订另外的专门的条款。

  6. 你不许使用我的商品名、商标、服务标志或产品名。

  7. 本作品是按原样 (AS IS) 提供的,没有任何保证啊,你懂的。

  8. 我可不负任何责任。除非我书面同意,或者法律有这样的要求 (例如对故意和重大过失行为负责)。

  9. 你可以向别人提供保证,你可以向别人收费,但那都是你的事,别给我惹麻烦。

注意以上的,既包含了许可人,也包含了每位贡献者

何以解忧,唯有代码。不忘初心,方得始终。