https://github.com/marcos-monte/historicipca-api

https://github.com/marcos-monte/historicipca-api

Last synced: 21 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/marcos-monte/historicipca-api
• Owner: Marcos-Monte
• Created: 2024-02-27T09:30:42.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-02-27T09:57:44.000Z (11 months ago)
• Last Synced: 2024-02-27T11:16:29.190Z (11 months ago)
• Language: JavaScript
• Size: 671 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: ReadMe.md

Awesome Lists containing this project

README

        
API REST - Historic IPCA 💻




 Technologies • 

 Getting Started





    The API I've developed features a robust and flexible structure to meet diverse needs in the context of historical IPCA (Consumer Price Index for All Urban Consumers) information. Implemented with the REST (HTTP) communication protocol, the API offers four distinct routes, each tailored for different use cases:



- Complete Collection: 

- Route : /historicIPCA
This route returns the complete collection of historical IPCA data. It's useful when users need all available records without specific filters.



- Filtered Collection by Year: 

- Route : /historicIPCA?year={year}
By providing the "year" parameter in this route, users can obtain a filtered collection containing only records for the specified year. This facilitates obtaining specific information for more detailed temporal analyses.



- Specific Record by ID: 

- Route : /historicIPCA/:{id}
This route enables the retrieval of a single record from the collection, identified by its unique ID. It's useful when there's a need to access specific details of a particular IPCA data point.



- Adjustment Calculation: 

- Route : /historicIPCA/calculo?valor={valor}&mesInicial={mesInicial}&anoInicial={anoInicial}&mesFinal={mesFinal}&anoFinal={anoFinal}
The adjustment calculation route allows users to make adjustment projections based on available API data. By providing appropriate parameters such as initial value, adjustment rate, and period, users get an estimate of the adjusted value over time.





     📱Visit the Project repository



💻 Technologies


- Express

- Postman

- API RESTful

- NodeJS

- Git / Github

🚀 Getting started


Prerequisites


- JavaScript Development Environment: [NodeJS](https://nodejs.org/en)

- Versioning Control: [Git](https://git-scm.com/)

Cloning


How to clone the project

```bash

git clone https://github.com/Marcos-Monte/historicIPCA-API

```

Starting


How to start the project

```bash

cd historicIPCA-API

node index.js

```

Address


How to access the project in the browser

```bash

http://localhost:3333/historicIPCA

```