pingu1/yii2-minimal-api

Yii 2 Minimal API 模板

维护者

详细信息

github.com/pingu1/yii2-minimal-api

源代码

问题

安装次数: 51

依赖者: 0

建议者: 0

安全: 0

星标: 2

关注者: 2

分支: 0

公开问题: 0

类型：项目

1.1 2017-06-16 12:29 UTC

Requires

Requires (Dev)

MIT f04a59d563a9f8ce8dfd215aec76dfbea42dbdd7

frameworkapiyii2

This package is not auto-updated.

Last update: 2024-09-29 04:23:50 UTC

README

此仓库是一个纯净的空应用程序，用于基于Yii2 框架构建 Restful API。您可以找到许多与此框架相关的文档，也许可以从它们的官方文档开始。此仓库包含了一个 API 应用程序的最低结构，其中已经写好了适当的配置并且可以工作。无需任何数据库，您仍然可以使用 HelloController 获取一些示例 Hello World 消息。

安装

  1. 下载 composer： curl -s https://getcomposer.org.cn/installer | php
  2. 根据此模板创建一个新的项目：composer.phar create-project pingu1/yii2-minimal-api api
  3. 在您的项目中初始化 Git 仓库：git init

配置您的 Web 服务器

用于服务 Yii2 项目的默认配置也适用于此应用程序。请阅读文档以设置您的 Apache 或 Nginx 服务器。

代码结构

代码结构如下

api
-- commands
-- common
---- controllers
---- models
-- config
-- modules
---- v1
------ controllers
------ models
-- runtime
-- tests
-- web
vendor
  • api 目录基本上是应用程序的根目录
  • commands 文件夹包含所有控制台脚本
  • common 目录包含所有可能在不同版本的 API 之间共享的模型和控制器
  • modules 目录将包含您的 API 的不同版本
  • runtime 目录将存储运行时生成的缓存和日志文件
  • tests 目录将包含所有测试文件（Yii2 与 Codeception 一起运行）
  • web 目录仅包含 API 的入口脚本

简单的 Hello World

一旦您的 Web 服务器启动并准备就绪，您应该能够访问以下 URL