来自 APP下载 2019-09-15 10:04 的文章
当前位置: 新萄京娱乐手机版 > APP下载 > 正文

实现方式

概述

上一篇已经涉及如何设置以及使用 phoenix framework 来支付几个简单易行的 api。 接着上次的工程,下边演示如何通过 phoenix framework 来创设各种类型的 api 来应对前边一个的每一样乞求。

上边选用的工程的全部代码已经公开在:

种种 api 的落到实处示例

restful url 的参数

introduce by code:

  • controller 中相关代码:
    @doc "/api/param/:name"
    def rest_param1(conn, %{"name" => name}) do
      json conn, %{
        "result": "success",
        "message": "your name is " <> name,
      }
    end

    @doc "/api/param/:name/:age"
    def rest_param2(conn, %{"name" => name, "age" => age}) do
      json conn, %{
        "result": "success",
        "message": "your name is " <> name <> " and age is " <> age,
      }
    end
  • router 相关代码: (router.ex)

    get "/param/:name", ApiParamController, :rest_param1
    get "/param/:name/:age", ApiParamController, :rest_param2
    
  • 开行 phoenix 开采服务器,就能够在浏览器中做客对应的 ULX570L

    mix phoenix.server
    

在 浏览器 中访问 和 能够见到重回的 json。

GET 央求中的参数

introduce by code: api的参数的方面包车型大巴亲自去做同样

  • controller 中相关代码:(api_param_controller.ex)

    @doc "/api/param?name=xxx&age=yyy"
    def rest_param3(conn, params) do
      if Map.has_key?(params, "age") do
        json conn, %{
          "result": "success from rest_param3",
          "message": "your name is " <> params["name"] <> " and age is " <> params["age"],
        }
      else
        json conn, %{
          "result": "success from rest_param3",
          "message": "your name is " <> params["name"],
        }
      end
    end
    
  • router 相关代码: (router.ex)

    get "/param", ApiParamController, :rest_param3
    
  • 开发银行 phoenix 开拓服务器,就能够在浏览器中做客对应的 U昂科威L

    mix phoenix.server
    

在 浏览器 中访问 和 能够看出重返的 json。

POST 诉求中的参数

introduce by code: api的参数的地点的演示一样

  • controller 中相关代码:(api_param_controller.ex)

    @doc "/api/param"
    def post_param(conn, params) do
      if Map.has_key?(params, "age") do
        json conn, %{
          "result": "success from post_param",
          "message": "your name is " <> params["name"] <> " and age is " <> params["age"],
        }
      else
        json conn, %{
          "result": "success from post_param",
          "message": "your name is " <> params["name"],
        }
      end
    end
    
  • router 相关代码: (router.ex)

    post "/param", ApiParamController, :post_param
    
  • 启航 phoenix 开拓服务器,就可以在浏览器中拜谒对应的 ULacrosseL

    mix phoenix.server
    

测验api 能够行使 curl 命令:

    curl -X POST -H "Cache-Control: no-cache" -F "name=wyb" "http://localhost:4000/api/param"
    curl -X POST -H "Cache-Control: no-cache" -F "name=wyb" -F "age=33" "http://localhost:4000/api/param"

json 格式参数

introduce by code: api的参数的地方的以身作则同样

  • controller 中相关代码:(api_param_controller.ex)

    @doc "/api/json-param"
    def json_param(conn, params) do
      if Map.has_key?(params, "age") do
        json conn, %{
          "result": "success from json_param",
          "message": "your name is " <> params["name"] <> " and age is " <> to_string(params["age"]),
        }
      else
        json conn, %{
          "result": "success from json_param",
          "message": "your name is " <> params["name"],
        }
      end
    end
    
  • router 相关代码: (router.ex)

    post "/json-param", ApiParamController, :json_param
    
  • 运行 phoenix 开垦服务器,就足以在浏览器中访谈对应的 UGL450L

    mix phoenix.server
    

测量试验api 能够运用 curl 命令:

    curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
        "name": "wyb"
    }' "http://localhost:4000/api/json-param"

    curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
        "name": "wyb",
        "age": 33
    }' "http://localhost:4000/api/json-param"

下载 文件

introduce by code: api的参数的地点的身体力行同样

  • controller 中相关代码:(api_param_controller.ex)

    @doc "/api/file-param"
    def file_param(conn, params) do
      filepath = "/tmp/downloadfile.txt"
      if Map.has_key?(params, "age") do
        File.write(filepath, "your name is " <> params["name"] <> " and age is " <> to_string(params["age"]))
      else
        File.write(filepath, "your name is " <> params["name"])
      end
    
      conn |> send_file(200, filepath)
    end
    
  • router 相关代码: (router.ex)

    get "/file-param", ApiParamController, :file_param
    
  • 起步 phoenix 开拓服务器,就足以在浏览器中拜候对应的 U宝马X5L

    mix phoenix.server
    

在 浏览器 中访问 和 能够见到重返的 json。

上传 文件

introduce by code: api的参数的方面包车型地铁演示同样

  • controller 中相关代码:(api_param_controller.ex)

    @doc "/api/file-param"
    def upload_param(conn, params) do
    
      file = params["file"]
      File.cp(file.path, "/tmp/upload.file")
    
      json conn, %{
        "result": "success from file_param",
        "message": "your name is " <> params["name"] <> " and age is " <> to_string(params["age"])
        <> " and the filename which you upload is " <> file.filename,
      }
    end
    
  • router 相关代码: (router.ex)

    post "/file-param", ApiParamController, :upload_param
    
  • 运维 phoenix 开辟服务器,就能够在浏览器中拜会对应的 UEscortL

    mix phoenix.server
    

测量试验api 能够行使 curl 命令: 命令中的 file 要替换来你的实际文件路线

    curl -X POST -H "Cache-Control: no-cache" -H "Content-Type: multipart/form-data" 
        -F "name=wyb" -F "age=33" -F "file=@/tmp/test.jpg" "http://localhost:4000/api/file-param"

总结

可以看岀,phoenix framework 的 Plug 提供了丰裕的效应,所以编写 api 特别有利。 精晓了上边的示范,基本就足以满足创设web服务时大部分的 api 的写法了。

来源:

本文由新萄京娱乐手机版发布于APP下载,转载请注明出处:实现方式

关键词: