Merge pull request #13 from Mteheran/develop

Moving changes to main

Author: Mteheran

.all-contributorsrc

@@ -46,6 +46,16 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "Alejandrohv06",
+      "name": "Alejandro Herreño",
+      "avatar_url": "https://avatars.githubusercontent.com/u/99321349?v=4",
+      "profile": "https://www.linkedin.com/in/alejandrohv/",
+      "contributions": [
+        "doc",
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.gitignore

@@ -348,3 +348,4 @@ MigrationBackup/
 
 # Ionide (cross platform F# VS Code tools) working folder
 .ionide/
+api/appsettings.Development.json

README.md

@@ -1,13 +1,64 @@
-# api-colombia
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
-public api that contains info about Colombia, departments, cities, tourists places and presidents
+# API-COLOMBIA
 
-## Contributors ✨
+## Introduction
+API Colombia is a public RESTful API that enable users to obtain a variety of public information about the country "Colombia".
 
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+## Project Support Features
+* Minimal API's endpoints to get information about:
+  - General information about the country.
+  - Departments/States.
+  - Cities.
+  - Presidents.
+  - Tourist attractions.
+* Swagger documentation 
+* Does not requiere  authentication.
+## Versions
+* 1.0
+## Installation Guide
+* Clone this repository [here](https://github.com/Mteheran/api-colombia).
+* The develop branch is the most stable branch at any given time, ensure you're working from it.
+* [.NET CORE SDK ](https://dotnet.microsoft.com/en-us/download) must be installed in the machine.
+* Update the connection string to your prefered database in the "appsettings.json" file.
+* Run `dotnet build` command to generate the build of the project.
+
+## Usage
+Public URL: TBD
+* Swagger documentation can be found in the URL: "{PUBLIC_URL}/swagger/index.html"
+
+## API Endpoints
+| HTTP Verbs | Endpoints                             | Action                                                               |
+| ---------- | ------------------------------------- | -------------------------------------------------------------------- |
+| GET        | /api/{version}/city                   | Get the list of all the cities                                       |
+| GET        | /api/{version}/city/{id}              | Get the information of a city by it is id                            |
+| GET        | /api/{version}/city/name/{name}       | Get the information of a city by it is name                          |
+| GET        | /api/{version}/country/Colombia       | Get the information of Colombia                                      |
+| GET        | /api/{version}/Department             | Get the list of all the departments in Colombia                      |
+| GET        | /api/{version}/Department/{id}        | Get the information of a department by it is id                      |
+| GET        | /api/{version}/Department/name/{name} | Get the information of a department by it is name                    |
+| GET        | /api/{version}/President              | Get the list of all the presidents in Colombia                       |
+| GET        | /api/{version}/President/{id}         | Get the information of a president by it is id                       |
+| GET        | /api/{version}/President/name/{name}  | Get the information of a president by it is name                     |
+| GET        | /api/{version}/President/year/{name}  | Get the information of a president that ruled during a specific year |
+| GET        | /api/{version}/TouristicAttraction             | Get the list of all the touristic attractions in Colombia                      |
+| GET        | /api/{version}/TouristicAttraction/{id}        | Get the information of a touristic attraction by it is id                      |
+| GET        | /api/{version}/TouristicAttraction/name/{name} | Get the information of a touristic attaction by it is name                    |
 
+## Response Example 
+* Content type: "application/json". Responses are JSON Objects. 
+* Response header contains the HTTP CODE with the status. 
+* Example:
+ 
+>{"id":1,"name":"Colombia","description":"Colombia, officially the Republic of Colombia, is a country in South America with insular regions in North America—near Nicaragua's Caribbean coast—as well as in the Pacific Ocean. The Colombian mainland is bordered by the Caribbean Sea to the north, Venezuela to the east and northeast, Brazil to the southeast, Ecuador and Peru to the south and southwest, the Pacific Ocean to the west, and Panama to the northwest. Colombia is divided into 32 departments and the Capital District of Bogotá, the country's largest city. It covers an area of 1,141,748 square kilometers (440,831 sq mi), and has a population of 52 million. Colombia's cultural heritage—including language, religion, cuisine, and art—reflects its history as a Spanish colony, fusing cultural elements brought by immigration from Europe and the Middle East, with those brought by enslaved Africans, as well as with those of the various Indigenous civilizations that predate colonization. Spanish is the official state language, although English and 64 other languages are recognized regional languages.","stateCapital":"Bogotá","surface":1141748,"population":52235050,"languages":["Spanish","English"],"timeZone":"UTC-5","currency":"Colombian Peso","currencyCode":"COP","isoCode":"CO","internetDomain":".co","phonePrefix":"+57","radioPrefix":"HK","aircraftPrefix":"HK"}
+## Technologies Used
+* [.NET Core 6.*](https://dotnet.microsoft.com/en-us/) is a free, cross-platform, open source developer platform for building many kinds of applications. .NET is built on a high-performance runtime that is used in production by many high-scale apps.
+* [PostgreSQL](https://www.postgresql.org/) is a powerful, open source object-relational database system with over 35 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.
+* [Microsoft Azure](https://azure.microsoft.com/en-us/resources/cloud-computing-dictionary/what-is-azure/) The Azure cloud platform is more than 200 products and cloud services designed to help you bring new solutions to life—to solve today’s challenges and create the future. Build, run, and manage applications across multiple clouds, on-premises, and at the edge, with the tools and frameworks of your choice.
+
+## Contributors ✨
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
@@ -18,6 +69,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/rina-plata/"><img src="https://avatars.githubusercontent.com/u/55161289?v=4?s=100" width="100px;" alt="Rina Plata"/><br /><sub><b>Rina Plata</b></sub></a><br /><a href="https://github.com/Mteheran/api-colombia/mteheran/api-colombia/commits?author=rinaplata" title="Documentation">📖</a> <a href="#tutorial-rinaplata" title="Tutorials">✅</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/veronicaguaman/"><img src="https://avatars.githubusercontent.com/u/70024610?v=4?s=100" width="100px;" alt="Veronica Guaman"/><br /><sub><b>Veronica Guaman</b></sub></a><br /><a href="https://github.com/Mteheran/api-colombia/mteheran/api-colombia/commits?author=VeronicaGuaman" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/mariobot/"><img src="https://avatars.githubusercontent.com/u/1220191?v=4?s=100" width="100px;" alt="Mario Botero"/><br /><sub><b>Mario Botero</b></sub></a><br /><a href="https://github.com/Mteheran/api-colombia/mteheran/api-colombia/commits?author=mariobot" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/alejandrohv/"><img src="https://avatars.githubusercontent.com/u/99321349?v=4?s=100" width="100px;" alt="Alejandro Herreño"/><br /><sub><b>Alejandro Herreño</b></sub></a><br /><a href="https://github.com/Mteheran/api-colombia/mteheran/api-colombia/commits?author=Alejandrohv06" title="Documentation">📖</a> <a href="https://github.com/Mteheran/api-colombia/mteheran/api-colombia/commits?author=Alejandrohv06" title="Code">💻</a></td>
     </tr>
   </tbody>
   <tfoot>
@@ -36,4 +88,6 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+## License
+*Open Source*

api/Program.cs

@@ -22,6 +22,17 @@
     });
 });
 
+builder.Services.AddCors(options =>
+{
+    options.AddPolicy(name: "corsApiColombia",
+                      policy  =>
+                      {
+                          policy.WithMethods("GET");
+                          policy.AllowAnyOrigin();
+                      });
+});
+
+
 builder.Configuration.AddEnvironmentVariables();
 
 builder.Services.AddNpgsql<DBContext>(builder.Configuration.GetConnectionString("DefaultConnection"));
@@ -37,6 +48,7 @@
 
 app.UseDefaultFiles();
 app.UseStaticFiles();
+app.UseCors("corsApiColombia");
 app.UseSwagger();
 app.UseSwaggerUI();
 

api/Routes/CityRoutes.cs

@@ -13,7 +13,7 @@ public static void RegisterCityAPI(WebApplication app)
                 return Results.Ok(db.Cities.ToList());
             });
 
-            app.MapGet($"{API_CITY_ROUTE_COMPLETE}/{Util.QP_ID}", async (int id, DBContext db) =>
+            app.MapGet($"{API_CITY_ROUTE_COMPLETE}/{{id}}", async (int id, DBContext db) =>
             {
                 var city = await db.Cities.FindAsync(id);
 
@@ -25,7 +25,7 @@ public static void RegisterCityAPI(WebApplication app)
                 return Results.Ok(city);
             });
 
-            app.MapGet($"{API_CITY_ROUTE_COMPLETE}/{Util.QP_NAME}", (string name, DBContext db) =>
+            app.MapGet($"{API_CITY_ROUTE_COMPLETE}/name/{{name}}", (string name, DBContext db) =>
             {
                 var city = db.Cities.Where(x => x.Name.ToUpper().Equals(name.Trim().ToUpper())).ToList();
 

api/Routes/DepartmentRoutes.cs

@@ -13,7 +13,7 @@ public static void RegisterDepartmentAPI(WebApplication app)
                 return Results.Ok(db.Departments.ToList());
             });
 
-            app.MapGet($"{API_DEPARTMENT_ROUTE_COMPLETE}/{Util.QP_ID}", async (int id, DBContext db) =>
+            app.MapGet($"{API_DEPARTMENT_ROUTE_COMPLETE}/{{id}}", async (int id, DBContext db) =>
             {
                 var departament = await db.Departments.FindAsync(id);
 
@@ -25,7 +25,7 @@ public static void RegisterDepartmentAPI(WebApplication app)
                 return Results.Ok(departament);
             });
 
-            app.MapGet($"{API_DEPARTMENT_ROUTE_COMPLETE}/{Util.NAME}/{Util.QP_NAME}", (string name, DBContext db) =>
+            app.MapGet($"{API_DEPARTMENT_ROUTE_COMPLETE}/name/{{name}}", (string name, DBContext db) =>
             {
                 var departments = db.Departments.Where(x => x.Name!.ToUpper().Equals(name.Trim().ToUpper())).ToList();
 

api/Routes/PresidentRoutes.cs

@@ -13,7 +13,7 @@ public static void RegisterPresidentApi(WebApplication app)
                 return Results.Ok(db.Presidents.ToList());
             });
 
-            app.MapGet($"{API_DEPARTMENT_ROUTE_COMPLETE}/{Util.QP_ID}", async (int id, DBContext db) =>
+            app.MapGet($"{API_DEPARTMENT_ROUTE_COMPLETE}/{{id}}", async (int id, DBContext db) =>
             {
                 var president = await db.Presidents.FindAsync(id);
 
@@ -25,7 +25,7 @@ public static void RegisterPresidentApi(WebApplication app)
                 return Results.Ok(president);
             });
 
-            app.MapGet($"{API_DEPARTMENT_ROUTE_COMPLETE}/{Util.NAME}/{Util.QP_NAME}", (string name, DBContext db) =>
+            app.MapGet($"{API_DEPARTMENT_ROUTE_COMPLETE}/name/{{name}}", (string name, DBContext db) =>
             {
                 var president = db.Presidents.Where(x => x.Name!.ToUpper().Equals(name.Trim().ToUpper())).ToList();
 
@@ -36,6 +36,16 @@ public static void RegisterPresidentApi(WebApplication app)
 
                 return Results.Ok(president);
             });
+
+
+            app.MapGet($"{API_DEPARTMENT_ROUTE_COMPLETE}/year/{{year}}", async (int year, DBContext db) =>
+            {
+                var presidents = db.Presidents
+                                        .Where(p=> p.StartPeriodDate.Year >= year
+                                         && p.EndPeriodDate.Year <= year);
+
+                return Results.Ok(presidents);
+            });
         }
     }
 }

api/Routes/TuristicAttactionRoutes.cs api/Routes/TouristicAttactionRoutes.csapi/Routes/TuristicAttactionRoutes.cs renamed to api/Routes/TouristicAttactionRoutes.cs

@@ -6,14 +6,14 @@ public static class TuristicAttactionRoutes
     {
         public static void RegisterTuristicAttactionAPI(WebApplication app)
         {
-            const string API_DEPARTMENT_ROUTE_COMPLETE = $"{Util.API_ROUTE}{Util.API_VERSION}{Util.TURISTIC_ROUTE}";
+            const string API_TOURISTIC_ROUTE_COMPLETE = $"{Util.API_ROUTE}{Util.API_VERSION}{Util.TOURISTIC_ROUTE}";
 
-            app.MapGet(API_DEPARTMENT_ROUTE_COMPLETE, (DBContext db) =>
+            app.MapGet(API_TOURISTIC_ROUTE_COMPLETE, (DBContext db) =>
             {
                 return Results.Ok(db.TouristAttractions.ToList());
             });
 
-            app.MapGet($"{API_DEPARTMENT_ROUTE_COMPLETE}/{Util.QP_ID}", async (int id, DBContext db) =>
+            app.MapGet($"{API_TOURISTIC_ROUTE_COMPLETE}/{{id}}", async (int id, DBContext db) =>
             {
                 var turisticAtt = await db.TouristAttractions.FindAsync(id);
 
@@ -25,7 +25,7 @@ public static void RegisterTuristicAttactionAPI(WebApplication app)
                 return Results.Ok(turisticAtt);
             });
 
-            app.MapGet($"{API_DEPARTMENT_ROUTE_COMPLETE}/{Util.NAME}/{Util.QP_NAME}", (string name, DBContext db) =>
+            app.MapGet($"{API_TOURISTIC_ROUTE_COMPLETE}/name/{{name}}", (string name, DBContext db) =>
             {
                 var turisticAtt = db.TouristAttractions.Where(x => x.Name!.ToUpper().Equals(name.ToUpper())).ToList();
 

api/Utils/Util.cs

@@ -6,13 +6,10 @@ public static class Util
         public const string COUNTRY_ROUTE = "Country";
         public const string DEPARTMENT_ROUTE = "Department";
         public const string PRESIDENT_ROUTE = "President";
-        public const string TURISTIC_ROUTE = "TurusticAttaction";
+        public const string TOURISTIC_ROUTE = "TouristicAttraction";
 
         public const string API_ROUTE = "api/";
         public const string API_VERSION = "v1/";
-        public const string NAME = "Name";
-        public const string QP_ID = "Name";
-        public const string QP_NAME = "name";
 
         public const string COLOMBIA = "Colombia";
     }