{"id":20710823,"url":"https://github.com/gabrielagodek/restful-api","last_synced_at":"2026-04-10T02:57:07.029Z","repository":{"id":216973829,"uuid":"742848422","full_name":"GabrielaGodek/RESTful-API","owner":"GabrielaGodek","description":"Database-operating application enabling data filtering and sorting. It is built on the REST architecture. To ensure functionality, the system was tested using the Postman tool.","archived":false,"fork":false,"pushed_at":"2024-01-16T20:06:58.000Z","size":50,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-11T06:23:23.782Z","etag":null,"topics":["express","mongodb","mongoose","nodejs","postman","rest-api","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GabrielaGodek.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-13T14:54:45.000Z","updated_at":"2024-01-15T17:29:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"5580323b-88cf-4219-a4e0-7222b00bae14","html_url":"https://github.com/GabrielaGodek/RESTful-API","commit_stats":null,"previous_names":["gabrielagodek/ts-api","gabrielagodek/restful-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/GabrielaGodek/RESTful-API","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GabrielaGodek%2FRESTful-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GabrielaGodek%2FRESTful-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GabrielaGodek%2FRESTful-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GabrielaGodek%2FRESTful-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GabrielaGodek","download_url":"https://codeload.github.com/GabrielaGodek/RESTful-API/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GabrielaGodek%2FRESTful-API/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259804075,"owners_count":22913861,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["express","mongodb","mongoose","nodejs","postman","rest-api","typescript"],"created_at":"2024-11-17T02:13:16.967Z","updated_at":"2026-04-10T02:57:06.969Z","avatar_url":"https://github.com/GabrielaGodek.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RESTful API\n\nThe project allowed for gaining experience in creating a fully functional RESTful API, understanding web application architecture, handling MongoDB database, and using TypeScript in the Node.js environment. The implemented advanced filtering enables efficient data manipulation according to user needs.\n\n## Installation guide\n\n1. Clone this repository `https://github.com/GabrielaGodek/RESTful-API.git`\n2. Run `npm run build` to install all dependencies and compile TypeScript code to JavaScript and create `dist` folder\n3. Run `npm run start` to connect with MongoDB\n\n### Usage\n\nConnect to the API using Postman with address: `http://localhost:3000/api/v1/coffees/`\n\n## API Endpoints\n\n| HTTP   | Endpoints                                     | Action                                         |\n| ------ | --------------------------------------------- | ---------------------------------------------- |\n| POST   | /api/v1/coffees                               | To create new a coffee                         |\n| GET    | /api/v1/coffees                               | To retrieve all available coffees              |\n| GET    | /api/v1/coffees/:id                           | To retrieve details of a single coffee         |\n| PATCH  | /api/v1/coffees/:id                           | To edit the details of a single coffee         |\n| DELETE | /api/v1/coffees/:id                           | To delete a single coffee                      |\n| GET    | /api/v1/coffees?price[lte]=11\u0026name=Espresso   | To search specific coffee by values            |\n| GET    | /api/v1/coffees?sort=price                    | To sort results by price                       |\n| GET    | /api/v1/coffees?fields=name,description,price | To return only desired values not whole object |\n| GET    | /api/v1/coffees?page=2\u0026limit=5                | To display results with pagination             |\n| GET    | /api/v1/coffees/bestsellers                   | Alias for 3 cheapest coffee                    |\n\nClick here to see: [Postman Documentation](https://documenter.getpostman.com/view/29979715/2s9YXpWJpp) for this API\n\n## Technologies\n\n- [NodeJS](https://nodejs.org/) This is a cross-platform runtime environment built on Chrome's V8 JavaScript engine used in running JavaScript codes on the server. It allows for installation and managing of dependencies and communication with databases.\n- [ExpressJS](https://www.expresjs.org/) This is a NodeJS web application framework.\n- [MongoDB](https://www.mongodb.com/) This is a free open source NOSQL document database with scalability and flexibility. Data are stored in flexible JSON-like documents.\n- [Mongoose ODM](https://mongoosejs.com/) This makes it easy to write MongoDB validation by providing a straight-forward, schema-based solution to model to application data.\n\n## Authors\n\nGabriela Godek\n\n## License\n\nThis project is available for use under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgabrielagodek%2Frestful-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgabrielagodek%2Frestful-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgabrielagodek%2Frestful-api/lists"}