查看源代码 API 参考 Phoenix v1.7.14

模块

这是 Phoenix 项目的文档。

定义一个 Phoenix 频道。

用于测试 Phoenix 频道的便利功能。

一个用于处理自动代码重载的插件和模块。

用于测试 Phoenix 端点和连接相关帮助程序的便利功能。

控制器用于在同一个(可插拔的)模块中对公共功能进行分组。

定义了 Phoenix.Digester.Compressor 行为,用于实现静态文件压缩器。

Phoenix.Digester 的 Gzip 压缩器

定义一个 Phoenix 端点。

Phoenix 的 Cowboy2 适配器。

包装一个端点,如果引发了异常,则尝试与 Phoenix 的代码重载器同步,这表明我们可能正在进行重载。

提供共享闪存访问。

用于处理各种仪表事件记录的仪表。

当请求参数中期望存在某个键,但不存在时引发。

用于在 Phoenix 中对名称进行词形变化和处理的便利功能。

当一个 accept* 头部不被服务器接受时引发。

一个将数据结构转换为 URL 参数的协议。

向进程和频道提供 Presence 跟踪。

定义一个 Phoenix 路由器。

当 URI 在匹配时格式错误时引发的异常。

当找不到路由时引发的异常。

一个通过通道复用消息的套接字实现。

定义从发布订阅到频道以及反向发送的消息。

当套接字消息无效时引发。

定义通过传输到频道以及反向发送的消息。

定义从频道到传输发送的回复。

一种序列化传入和传出套接字消息的行为。

概述了 Socket <-> 传输通信。

用于在频道、API 身份验证等中对令牌中的数据进行签名/加密的便利功能。

提供带有编译时验证的路由生成。

Mix 任务

在本地更新 Phoenix 项目生成器。

打印 Phoenix 任务及其信息。

摘要和压缩静态文件。

删除旧版本的编译资产。

列出所有可用的 Phoenix 生成器。

为资源生成身份验证逻辑和相关视图。

为 HTTPS 测试生成自签名证书。

生成一个 Phoenix 频道。

围绕 Ecto 架构生成一个具有函数的上下文。

为在数据库之外转换/验证数据生成一个嵌入式 Ecto 架构。

为 HTML 资源生成带有视图、模板、架构和上下文的控制器。

为 JSON 资源生成控制器、JSON 视图和上下文。

为资源生成 LiveView、模板和上下文。

生成一个默认情况下通过电子邮件发送通知的通知器。

生成一个 Presence 跟踪器。

为基于发布的部署生成发布文件和可选的 Dockerfile。

生成一个 Ecto 架构和迁移。

生成一个秘密并将其打印到终端。

生成一个 Phoenix 套接字处理程序。

创建一个新的 Phoenix 项目。

在伞形项目中创建一个新的 Ecto 项目。

在伞形项目中创建一个新的 Phoenix web 项目。

打印默认路由器或给定路由器的所有路由。也可以定位指定 url 后面的控制器函数。

通过配置所有端点服务器来启动应用程序。