Refactor API /users

- Included examples on usage of query & params.

Author: iamWing

src/apis/users/index.ts

@@ -1,5 +1,46 @@
-import { FastifyInstance } from 'fastify';
+import { FastifyInstance, RequestGenericInterface } from 'fastify';
+
+interface ReqSchema extends RequestGenericInterface {
+  Querystring: {
+    id?: number
+  }
+}
+
+// Request schema validation & response serialisation
+const opts = {
+  schema: {
+    querystring: {
+      type: 'object',
+      properties: {
+        id: {
+          type: 'number',
+          nullable: true,
+        },
+      },
+    },
+  },
+  response: {
+    200: {
+      type: 'object',
+      properties: {
+        user_id: { type: 'number' },
+        validated: { type: 'boolean' },
+      },
+    },
+  },
+};
 
 export default async (fastify: FastifyInstance): Promise<void> => {
-  fastify.get('/', async (_req, _reply) => 'pong');
+  fastify.get<ReqSchema>('/', opts, async (req, reply) => {
+    const { id } = req.query;
+
+    if (id == null) {
+      await reply.redirect('/');
+    } else {
+      await reply.code(200).send({
+        user_id: id,
+        validated: id < 10,
+      });
+    }
+  });
 };

tests/apis/users.test.ts

@@ -7,18 +7,32 @@ beforeAll(async () => {
   server = await createServer();
 });
 
-test('users', async () => {
-  const res = await server.inject().get('/users');
+describe('APIs - /users', () => {
+  it('should redirect to index', async () => {
+    const res = await server.inject().get('/users');
+    expect(res.statusCode).toBe(302);
+  });
 
-  expect(res.statusCode).toBe(200);
-  expect(res.body).toMatch('pong');
+  it('should return true on user id validation', async () => {
+    const res = await server.inject().get('/users').query({ id: 1 });
+    expect(res.statusCode).toBe(200);
+    expect(res.json()).toEqual({ user_id: 1, validated: true });
+  });
+
+  it('should return false on user id validation', async () => {
+    const res = await server.inject().get('/users').query({ id: 10 });
+    expect(res.statusCode).toBe(200);
+    expect(res.json()).toEqual({ user_id: 10, validated: false });
+  });
 });
 
-test('user by id', async () => {
-  const res = await server.inject().get('/users/1');
+describe('API - /users/:id', () => {
+  it('should return user id passed in', async () => {
+    const res = await server.inject().get('/users/1');
 
-  expect(res.statusCode).toBe(200);
-  expect(res.json()).toEqual({ user: 1 });
+    expect(res.statusCode).toBe(200);
+    expect(res.json()).toEqual({ user: 1 });
+  });
 });
 
 afterAll(async () => {