Test array query params in example phoenix app (#667)

Author: zorbash

examples/phoenix_app/lib/phoenix_app/accounts/accounts.ex

@@ -2,8 +2,19 @@ defmodule PhoenixApp.Accounts do
   alias PhoenixApp.Accounts.User
   alias PhoenixApp.Repo
 
-  def list_users() do
-    Repo.all(User)
+  import Ecto.Query
+
+  def list_users(filters) do
+    query = from(u in User, order_by: [asc: u.id])
+
+    query =
+      if filters[:ids] do
+        from(u in query, where: u.id in ^filters[:ids])
+      else
+        query
+      end
+
+    Repo.all(query)
   end
 
   def get_user!(id) do

examples/phoenix_app/lib/phoenix_app_web/controllers/user_controller.ex

@@ -21,13 +21,22 @@ defmodule PhoenixAppWeb.UserController do
   operation :index,
     summary: "List users",
     description: "List all users",
+    parameters: [
+      OpenApiSpex.Operation.parameter(
+        :ids,
+        :query,
+        %Schema{type: :array, items: %Schema{type: :integer}},
+        "Filter by user ids"
+      )
+    ],
     responses: [
       ok: {"User List Response", "application/json", Schemas.UsersResponse},
       unprocessable_entity: %Reference{"$ref": "#/components/responses/unprocessable_entity"}
     ]
 
-  def index(conn, _params) do
-    users = Accounts.list_users()
+  def index(conn, params) do
+    users = Accounts.list_users(params)
+
     render(conn, "index.json", users: users)
   end
 
@@ -37,8 +46,7 @@ defmodule PhoenixAppWeb.UserController do
     parameters: [
       group_id: [in: :path, type: :integer, description: "Group ID", example: 1]
     ],
-    request_body:
-      {"The user attributes", "application/json", Schemas.UserRequest, required: true},
+    request_body: {"The user attributes", "application/json", Schemas.UserRequest, required: true},
     responses: [
       created: {"User", "application/json", Schemas.UserResponse}
     ]
@@ -88,8 +96,7 @@ defmodule PhoenixAppWeb.UserController do
         required: true
       ]
     ],
-    request_body:
-      {"The user attributes", "application/json", Schemas.UserRequest, required: true},
+    request_body: {"The user attributes", "application/json", Schemas.UserRequest, required: true},
     responses: [
       ok: {"User", "application/json", Schemas.UserResponse}
     ]

examples/phoenix_app/lib/phoenix_app_web/controllers/user_controller_with_struct_specs.ex

@@ -4,8 +4,10 @@ defmodule PhoenixAppWeb.UserControllerWithStructSpecs do
   of using the ExDoc-based operation specs.
   """
   use PhoenixAppWeb, :controller
+
   import OpenApiSpex.Operation, only: [parameter: 5, request_body: 4, response: 3]
-  alias OpenApiSpex.{Operation, Reference}
+
+  alias OpenApiSpex.{Operation, Reference, Schema}
   alias PhoenixApp.{Accounts, Accounts.User}
   alias PhoenixAppWeb.Schemas
 
@@ -34,15 +36,24 @@ defmodule PhoenixAppWeb.UserControllerWithStructSpecs do
       summary: "List users",
       description: "List all useres",
       operationId: "UserController.index",
+      parameters: [
+        OpenApiSpex.Operation.parameter(
+          :ids,
+          :query,
+          %Schema{type: :array, items: %Schema{type: :integer}},
+          "Filter by user ids"
+        )
+      ],
       responses: %{
         200 => response("User List Response", "application/json", Schemas.UsersResponse),
         422 => %Reference{"$ref": "#/components/responses/unprocessable_entity"}
       }
     }
   end
 
-  def index(conn, _params) do
-    users = Accounts.list_users()
+  def index(conn, params) do
+    users = Accounts.list_users(params)
+
     render(conn, "index.json", users: users)
   end
 
@@ -56,9 +67,7 @@ defmodule PhoenixAppWeb.UserControllerWithStructSpecs do
         Operation.parameter(:group_id, :path, :integer, "Group ID", example: 1)
       ],
       requestBody:
-        request_body("The user attributes", "application/json", Schemas.UserRequest,
-          required: true
-        ),
+        request_body("The user attributes", "application/json", Schemas.UserRequest, required: true),
       responses: %{
         201 => response("User", "application/json", Schemas.UserResponse)
       }

examples/phoenix_app/test/phoenix_app_web/controllers/user_controller_test.exs

@@ -34,17 +34,17 @@ defmodule PhoenixAppWeb.UserControllerTest do
     %{id: id2} =
       PhoenixApp.Repo.insert!(%PhoenixApp.Accounts.User{name: "Benjamin", email: "[email protected]"})
 
-    %{id: id3} =
+    %{id: _id3} =
       PhoenixApp.Repo.insert!(%PhoenixApp.Accounts.User{name: "Chuck", email: "[email protected]"})
 
     response =
       conn
       |> Plug.Conn.put_req_header("accept", "application/json")
-      |> get(user_path(conn, :index))
+      |> get(user_path(conn, :index), ids: [id1, id2])
       |> json_response(200)
       |> assert_schema("UsersResponse", spec)
 
-    assert [%{id: ^id1}, %{id: ^id2}, %{id: ^id3}] = response.data
+    assert [%{id: ^id1}, %{id: ^id2}] = response.data
   end
 
   test "User schema example", %{spec: spec} do