安装 phoenix framework

安装 phoenix 很简单：

mix archive.install https://github.com/phoenixframework/archives/raw/master/phoenix_new.ez

安装之后，mix 的子命令中就多了 phoenix 相关的内容了。

$ mix help | grep phoenix
$ mix local.phoenix     # Updates Phoenix locally
$ mix phoenix.new       # Creates a new Phoenix v1.2.1 application

phoenix 工程介绍

接下来，我们创建一个 phoenix 的工程。

$ mix phoenix.new phoenix_api --no-ecto     # 本示例中不带数据库的操作，所以加上 --no-ecto 参数$ cd phoenix_api       # 创建完之后进入工程目录
$ tree -L 1 .          # 查看目录结构
.
├── README.md
├── _build
├── brunch-config.js
├── config
├── deps
├── lib
├── mix.exs
├── mix.lock
├── node_modules
├── package.json
├── priv
├── test
└── web          # 主要的代码都要这里

phoenix 是个完整的 web 框架，包括 controller，view以及model，template等等，但是我们这里只用 phoenix 作为 api 的后端，所以前端相关的内容就不介绍了。用 phoenix 作为 api 的后端，主要关注 web/router.ex 文件和 web/controllers 文件夹，其他的件暂时不用理会。

创建 http api

接下来，使用 phoenix 实际创建一个简单的 api 来感受一下。首先，增加一个 controller，其中是api的具体实现代码

defmodule PhoenixApi.HelloController douse PhoenixApi.Web, :controllerdef hello(conn, _params) dojson conn, %{"hello": "world"}end
end

新增的 controller 路径： web/controllers/hello_controller.ex

controller 增加了之后，再在 web/router.ex 中增加一个指向 controller 中 hello 方法的路由， web/router.ex 已经有了针对 api 的 pipeline，只要增加如下代码即可。

scope "/api", PhoenixApi dopipe_through :apiget "/hello", HelloController, :hello
end

然后启动 phoenix server，在工程根目录下执行：

$ mix phoenix.server
Compiling 7 files (.ex)
[info] Running PhoenixApi.Endpoint with Cowboy using http://localhost:4000
26 Aug 16:43:04 - info: compiled 6 files into 2 files, copied 3 in 1.2 sec

最后在浏览器中访问 http://localhost:4000/api/hello 可以看到返回的JSON结果

{"hello": "world"
}

总结

Web app的前后端分离是趋势，phoenix framework 虽然是类似 RoR 的全栈 web framework，只用它来开发api也是不错的选择。用它来开发 api，我们可以暂时不关心 view 和 template 部分，将重点放在 controller 和 router 上。

来源：http://blog.iotalabs.io/

本文转自wang_yb博客园博客，原文链接：http://www.cnblogs.com/wang_yb/p/5823891.html，如需转载请自行联系原作者

phoenix 开发API系列（一）创建简单的http api相关推荐

API系列（一）：SMS API
API系列(一):SMS API 简介一. CONTACT GROUPS API 1. 总概 2. Create a group 3. View a group 4. Update a group ...
WEB API系列（一）：WEB API的适用场景、第一个实例
在我前一篇博客<WebAPI前置知识:HTTP与RestfulAPI>中已经给各位简单介绍了HTTP协议与RestFul API的关系,以及一些基本的HTTP协议知识,在这些知识的铺垫下, ...
Web API 2 入门——创建ASP.NET Web API的帮助页面（谷歌翻译）
在这篇文章中创建API帮助页面将帮助页面添加到现有项目添加API文档在敞篷下下一步作者:Mike Wasson 创建Web API时,创建帮助页面通常很有用,以便其他开发人员知道如何调用A ...
【Web API系列教程】1.2 — Web API 2中的Action Results
前言本节的主题是ASP.NET Web API怎样将控制器动作的返回值转换成HTTP的响应消息. Web API控制器动作能够返回下列的不论什么值: 1. void 2. HttpResponseM ...
phoenix 开发API系列目录
phoenix 开发API系列(一)创建简单的http api phoenix 开发API系列(二)phoenix 各类 api 实现方式 phoenix 开发API系列(三)phoenix api ...
WEB API 系列（二） Filter的使用以及执行顺序
在WEB Api中,引入了面向切面编程(AOP)的思想,在某些特定的位置可以插入特定的Filter进行过程拦截处理.引入了这一机制可以更好地践行DRY(Don't Repeat Yourself)思想 ...
在SAP云平台的API portal里创建和管理API
登录API Portal,创建一个新的API: API Provider字段,选择之前创建好的API provider,SAPDeveloperSystemES5,点击Discover按钮后,能看到该 ...
phoenix 开发API系列（三）phoenix api 结合数据库
概述介绍了 api 的各种写法之后,下面介绍构建 api 时与数据库连接的方式. 注下面使用的工程的完整代码已经公开在: http://git.oschina.net/wangyubin/phoe ...
phoenix 开发API系列（二）phoenix 各类 api 实现方式
概述上一篇已经提到如何安装以及利用 phoenix framework 来开发一个简单的 api. 接着上次的工程,下面演示如何通过 phoenix framework 来构建各种类型的 api 来 ...
openresty开发系列10--openresty的简单介绍及安装
openresty开发系列10--openresty的简单介绍及安装一.Nginx优点十几年前,互联网没有这么火,软件外包开发,信息化建设,帮助企业做无纸化办公,收银系统,工厂erp,c/s架构偏 ...

phoenix 开发API系列（一）创建简单的http api

安装 phoenix framework

phoenix 工程介绍

创建 http api

总结

phoenix 开发API系列（一）创建简单的http api相关推荐

最新文章

热门文章