Code Monkey home page Code Monkey logo

rest-api-with-mongodb's Introduction

rest-api-with-mongodb

This project implements a REST API that has CRUD operations, backed by a MongoDB database deployed within a container.

Table of Contents

Technologies

The project uses the following technologies:

  • Java
  • Spring Framework (for creating general infrastructure and supporting database interaction.)
  • Spring Boot (for application setup, configuration, and deployment)
  • Spring MVC (for handling HTTP requests and responses)
  • Spring Data (for interacting with databases)
  • Lombok (for reducing boilerplate code and enhancing Java classes)
  • MongoDB (as the database)
  • Maven (for dependency management)
  • Swagger (for API documentation)
  • Git (for version control)
  • Docker (for containerization)

Installation

To run the project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/YaremaMaksym/rest-api-with-mongodb.git
    
  2. Open the project in your preferred IDE.

  3. Type docker-compose up -d to start containers.

  4. Run the application

API's

  • GET /api/v1/students - get list of all students.
  • GET /api/v1/students/{email} - get student by email.
  • POST /api/v1/students - register new student.
  • PUT /api/v1/students/{email} - update fields of student.
  • DELETE /api/v1/students/{email} - delete student.

visit http://localhost:8090/swagger-ui/index.html after running app for more detailed documentation

rest-api-with-mongodb's People

Contributors

yaremamaksym avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.