My animal image API allows users to view images of animals in different sizes. Users can specify the size of the images they want to view, allowing for a customizable viewing experience. The API is designed to be fast and efficient, with optimized image retrieval mechanisms to ensure speedy delivery. Additionally, the API includes error handling and caching mechanisms to minimize downtime and ensure a smooth user experience.
Use the package manager npm to setup Placeholder project.
npm install to running server in development mode use
npm run start:d to running server in production mode use
npm run start:pIn order to use this api, you must pass the name of the animal, and that name must be a [ dog, cat, deer ], and then write the required width and height of the image
http://localhost:3000/{name}/{width}/{height}
//example
http://localhost:3000/cat/500/400to test this project you must execute this code in console
npm run testto format code use
npm run lint
//or use linter with auto fix
npm run lint:f
//or use just formater
npm run formatSo how does this project work? I want to explain to you first what are the components of the project and then explain to you how the requests are processed. First of all, there is a src/index.ts file. This is the main server file that runs the project
When sending a request to the server in this form cat/500/400, the request first passes through src/middleware/validParams.ts to ensure that the parameters are valid to complete the process, and then passes through src/middleware/fileExists.ts to make sure that the image already exists in the required size and saved in src/model/Image.ts file on array data and thumbnail, then the image is returned or the request is completed to the controller, and when the request reaches this point, the image is resized and saved to the server, then the resized image is returned