refactor: add prefix to /api to all routes

jellydn · Sep 24, 2023 · 051637f · 051637f
1 parent 16b8866
commit 051637f
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 13 deletions.
diff --git a/server.ts b/server.ts
@@ -45,12 +45,12 @@ void server.register(swaggerUI, {
 });
 
 // Health check
-server.get("/", async (_request, _reply) => ({ ok: true }));
+server.get("/api", async (_request, _reply) => ({ ok: true }));
 
 // Declare a route
 server.get<{
   Querystring: { name: string };
-}>("/hello", async (request) => {
+}>("/api/hello", async (request) => {
   const { name } = request.query;
   return { hello: name ?? "world" };
 });
@@ -71,7 +71,7 @@ const opts: RouteShorthandOptions = {
 };
 
 server.get(
-  "/ping",
+  "/api/ping",
   opts,
   async (_request: FastifyRequest, _reply: FastifyReply) => ({
     pong: "it worked!",

diff --git a/specs/generated.yaml b/specs/generated.yaml
@@ -8,22 +8,22 @@ tests:
     name: Default
     steps:
       - http:
-          url: /
+          url: /api
           method: GET
           schema:
             type: object
             properties:
               ok: bool
       - http:
-          url: /hello
+          url: /api/hello
           method: GET
           check:
             status: 200
             schema:
               type: object
               description: Successful response with a JSON object
       - http:
-          url: /ping
+          url: /api/ping
           method: GET
           check:
             status: 200

diff --git a/specs/openapi.yaml b/specs/openapi.yaml
@@ -9,13 +9,13 @@ externalDocs:
 servers:
   - url: http://localhost:3000
 paths:
-  /:
+  /api:
     get:
       responses:
         200:
           description: Default Response
           content: {}
-  /hello:
+  /api/hello:
     get:
       responses:
         200:
@@ -25,7 +25,7 @@ paths:
               schema:
                 type: string
                 description: Successful response with a JSON object
-  /ping:
+  /api/ping:
     get:
       responses:
         200:

diff --git a/specs/swagger.json b/specs/swagger.json
@@ -7,7 +7,7 @@
   },
   "definitions": {},
   "paths": {
-    "/": {
+    "/api": {
       "get": {
         "responses": {
           "200": {
@@ -16,7 +16,7 @@
         }
       }
     },
-    "/hello": {
+    "/api/hello": {
       "get": {
         "responses": {
           "200": {
@@ -25,7 +25,7 @@
         }
       }
     },
-    "/ping": {
+    "/api/ping": {
       "get": {
         "responses": {
           "200": {

diff --git a/workflow.yml b/workflow.yml
@@ -1,7 +1,7 @@
 version: "1.1"
 name: Api Check
 env:
-  host: localhost:3000
+  host: localhost:3000/api
 tests:
   ping:
     steps: