[add] remaining endPointGuide Route

Author: LinThitHtwe

constants/constant.ts

@@ -17,4 +17,23 @@ export const availableContinents = [
   "SouthAmerica",
 ];
 
-export const availableSovereignties = [];
+export const availableSovereignties = [
+  "Antarctic Treaty",
+  "Australia",
+  "British Crown",
+  "China",
+  "Denmark",
+  "Disputed",
+  "Finland",
+  "France",
+  "Netherlands",
+  "New Zealand",
+  "Norway",
+  "UK",
+  "UN",
+  "UN member",
+  "UN observer",
+  "United Kingdom",
+  "United States",
+  "US",
+];

controller/countryController.ts

@@ -1,6 +1,10 @@
 import { Request, Response } from "express";
 import { Country } from "../types/country";
-import { availableContinents, sovereigntyMapping } from "../constants/constant";
+import {
+  availableContinents,
+  availableSovereignties,
+  sovereigntyMapping,
+} from "../constants/constant";
 const countries = require("../data/countries.json");
 
 const getAllCountries = (_req: Request, res: Response) => {
@@ -24,7 +28,7 @@ const getCountriesByContinent = (req: Request, res: Response) => {
 
   if (countriesByContinent.length == 0) {
     const apiContinentGuide = {
-      message: "Continent Should be one of these",
+      message: `${req.params.continentName} isn't a valid continent. It should be one of these`,
       availableContinents,
     };
     res.json(apiContinentGuide);
@@ -47,6 +51,13 @@ const getCountriesBySovereignty = (req: Request, res: Response) => {
     return standardizedSovereignty === sovereigntyInput;
   });
 
+  if (countriesBySovereignty.length < 1) {
+    const apiSovereigntyGuide = {
+      message: `${req.params.sovereignty} isn't a valid sovereignty. It should be one of the following`,
+      availableSovereignties,
+    };
+    return res.status(400).json(apiSovereigntyGuide);
+  }
   return res.json(countriesBySovereignty);
 };
 

controller/endPointGuideController.ts

@@ -3,42 +3,78 @@ import {
   availableContinents,
   availableSovereignties,
 } from "../constants/constant";
+import generateGuideResponse from "../helper/generateGuideResponse";
 
 const index = (req: Request, res: Response) => {
   const fullUrl = req.fullUrl;
 
   const apiIndexGuide = {
-    allCountriesUrl: `${fullUrl}/all`,
-    countriesByContinent: `${fullUrl}/continent/{continentName}`,
-    countriesBySovereignty: `${fullUrl}/sovereignty/{sovereigntyName}`,
-    countryByISONumericCode: `${fullUrl}/isocode/numeric/{ISONumericCode}`,
-    countryByISOCode: `${fullUrl}/isocode/{ISOCode}`,
-    countriesByCurrencyCode: `${fullUrl}/currency/{currencyCode}`,
-    countryByTopLevelDomain: `${fullUrl}/topLevelDomain/{topLevelDomain}`,
-    countriesByDialingCode: `${fullUrl}/dialingCode/{dialingCode}`,
+    allCountriesUrl: `${fullUrl}/countries/all`,
+    countriesByContinent: `${fullUrl}/countries/continent/{continentName}`,
+    countriesBySovereignty: `${fullUrl}/countries/sovereignty/{sovereigntyName}`,
+    countryByISONumericCode: `${fullUrl}/countries/isocode/numeric/{ISONumericCode}`,
+    countryByISOCode: `${fullUrl}/countries/isocode/{ISOCode}`,
+    countriesByCurrencyCode: `${fullUrl}/countries/currency/{currencyCode}`,
+    countryByTopLevelDomain: `${fullUrl}/countries/topLevelDomain/{topLevelDomain}`,
+    countriesByDialingCode: `${fullUrl}/countries/dialingCode/{dialingCode}`,
   };
 
   res.json(apiIndexGuide);
 };
 
-const continent = (_req: Request, res: Response) => {
-  const apiContinentGuide = {
-    message: "Continent should be one of the following",
-    availableContinents,
-  };
-  res.status(404).json(apiContinentGuide);
+const continent = (req: Request, res: Response) => {
+  generateGuideResponse(req, res, "continent", "continentName", "Continent");
 };
 
-const sovereignty = (_req: Request, res: Response) => {
-  const apiSovereigntyGuide = {
-    message: "Sovereignty should be one of the following",
-    availableSovereignties,
-  };
-  res.status(404).json(apiSovereigntyGuide);
+const sovereignty = (req: Request, res: Response) => {
+  generateGuideResponse(
+    req,
+    res,
+    "sovereignty",
+    "sovereigntyName",
+    "Sovereignty"
+  );
+};
+
+const ISONumericCode = (req: Request, res: Response) => {
+  generateGuideResponse(
+    req,
+    res,
+    "isocode/numeric",
+    "ISONumericCode",
+    "ISO Numeric Code"
+  );
+};
+
+const ISOCode = (req: Request, res: Response) => {
+  generateGuideResponse(req, res, "isocode", "ISOCode", "ISOCode");
+};
+
+const currencyCode = (req: Request, res: Response) => {
+  generateGuideResponse(req, res, "currency", "ISOCode", "Currency Code");
+};
+
+const topLevelDomain = (req: Request, res: Response) => {
+  generateGuideResponse(
+    req,
+    res,
+    "topLevelDomain",
+    "topLevelDomain",
+    "Top Level Domain"
+  );
+};
+
+const dialingCode = (req: Request, res: Response) => {
+  generateGuideResponse(req, res, "dialingCode", "dialingCode", "Dialing Code");
 };
 
 export default {
   index,
   continent,
   sovereignty,
+  ISONumericCode,
+  ISOCode,
+  currencyCode,
+  topLevelDomain,
+  dialingCode,
 };

helper/generateGuideResponse.ts

@@ -0,0 +1,18 @@
+import { Request, Response } from "express";
+
+const generateGuideResponse = (
+  req: Request,
+  res: Response,
+  path: string,
+  paramName: string,
+  urlName: string
+) => {
+  const fullUrl = req.fullUrl;
+  const guide = {
+    message: `Invalid. ${paramName} url should be like down below`,
+    url: `${fullUrl}/countries/${path}/{${paramName}}`,
+  };
+  res.status(404).json(guide);
+};
+
+export default generateGuideResponse;

routes/endPointGuide.ts

@@ -0,0 +1,14 @@
+const router = require("express").Router();
+import endPointGuide from "../controller/endPointGuideController";
+
+router.get("/", endPointGuide.index);
+router.get("/countries", endPointGuide.index);
+router.get("/countries/continent", endPointGuide.continent);
+router.get("/countries/sovereignty", endPointGuide.sovereignty);
+router.get("/countries/isocode/numeric", endPointGuide.ISONumericCode);
+router.get("/countries/isocode", endPointGuide.ISOCode);
+router.get("/countries/currency", endPointGuide.currencyCode);
+router.get("/countries/topLevelDomain", endPointGuide.topLevelDomain);
+router.get("/countries/dialingCode", endPointGuide.topLevelDomain);
+
+export default router;

routes/route.ts

@@ -1,9 +1,8 @@
 const router = require("express").Router();
 import countryRoutes from "./countryRoute";
-import endPointGuide from "../controller/endPointGuideController";
+import endPointRoutes from "./endPointGuide";
 
-// router.get("/", endPointGuide.index);
-// router.get("/continent", endPointGuide.continent);
+router.use("/", endPointRoutes);
 router.use("/countries", countryRoutes);
 
 export default router;