Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/exploit-experts/rickandmorty-spring-api

RickAndMorty-Spring-API is a backend developed with Java and Spring Boot that implements a RESTful API to manage and list data from the Rick and Morty series. The project is prepared to be consumed by a separate front-end.
https://github.com/exploit-experts/rickandmorty-spring-api

api java maven restful-api spring

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/exploit-experts/rickandmorty-spring-api
Owner: Exploit-Experts
License: mit
Created: 2024-10-09T18:38:16.000Z (3 months ago)
Default Branch: master
Last Pushed: 2024-12-09T02:20:28.000Z (15 days ago)
Last Synced: 2024-12-17T03:08:43.735Z (7 days ago)
Topics: api, java, maven, restful-api, spring
Language: Java
Homepage:
Size: 238 KB
Stars: 0
Watchers: 0
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


    



# 🚀Rick and Morty Spring API

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

![GitHub pull requests](https://img.shields.io/github/issues-pr/Exploit-Experts/RickAndMorty-Spring-API)

![GitHub contributors](https://img.shields.io/github/contributors/Exploit-Experts/RickAndMorty-Spring-API)

RickAndMorty-Spring-API is a backend developed with Java and Spring Boot that implements a RESTful API to list data of characters from the Rick and Morty series. The project allows viewing character information and is prepared to be consumed by a separate front-end. 

This service provides a robust base for integration with client interfaces that consume character data through endpoints.

## 📋 Table of Contents

- [🎯 Objective](#objective)

- [🧑🏻‍💻 Credits](#credits)

- [🛠️ Technologies Used](#technologies-used)

- [📂 Installation and Execution](#installation-and-execution)

- [📃 Endpoints](#endpoints)

- [🤝 Contributing](#contributing)

- [⚖️ License](#license)

## Objective

Create a RESTful API that allows consuming and viewing data of characters from the Rick and Morty series, providing endpoints to be used in the [Angular front-end](https://github.com/Exploit-Experts/RickAndMorthy-client).

## Credits

||           |

| ---------------- | ---------------- |

|  | Bruno Magno |

|  | Paulo de Araujo |

|  | Marcelo Mesquita |

|  | Jonathan Rocha |

|  | Klismans Nazário |

|  | Leandro Oliveira |

## Technologies Used

- ![Java](https://img.shields.io/badge/Java-21-blue)

- ![MySQL](https://img.shields.io/badge/database-MySQL-blue)

- ![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.3.5-green)

- ![Spring Boot](https://img.shields.io/badge/Maven-3.9.9-green)

- ![Spring Data JPA](https://img.shields.io/badge/Spring%20Data%20JPA-3.3.4-green)

- ![Lombok](https://img.shields.io/badge/Lombok-1.18.34-green)

## Installation and Execution

1. Clone the repository:

```bash

git clone https://github.com/Exploit-Experts/RickAndMorty-Spring-API.git

```

2. Navigate to the project directory:

```bash

cd RickAndMorty-Spring-API

```

3. Copile project

```java

mvn clean install

```

4. Execute the jar

```

java -jar target/rickMorty-0.0.1-SNAPSHOT.jar

```

## Endpoints

- **Characters**

    - `GET /characters` - Retrieves all characters from the first page.

    - `GET /characters?page=1` - Retrieves all characters from a specific page.

    - `GET /characters`

      - Parameters:

        - `sort` (optional) - Sorts by a specific attribute (`NAME_ASC`, `NAME_DESC`, `STATUS_ASC`, `STATUS_DESC`).

        - `name` (optional) - Filters characters by name.

        - `status` (optional) - Filters characters by status (`ALIVE`, `DEAD`, `UNKNOWN`).

        - `species` (optional) - Filters characters by species.

        - `type` (optional) - Filters characters by type.

        - `gender` (optional) - Filters characters by gender (`FEMALE`, `MALE`, `GENDERLESS`, `UNKNOWN`).

    - `GET /characters/{id}` - Retrieves a specific character by ID.

    - `GET /characters/avatar/{id}.jpeg` - Retrieves the avatar of a specific character by ID.

- **Episodes**

    - `GET /episodes` - Retrieves all episodes from the first page.

    - `GET /episodes?page=2` - Retrieves all episodes from a specific page.

    - `GET /episodes`

      - Parameters:

        - `name` (optional) - Filters episodes by name.

        - `episode` (optional) - Filters episodes by code (expected format: `SXXEXX`).

        - `sort` (optional) - Sorts episodes by name (`NAME_ASC`, `NAME_DESC`) or episode code (`EPISODE_CODE`, `EPISODE_CODE_DESC`).

    - `GET /episodes/{id}` - Retrieves a specific episode by ID.

- **Locations**

    - `GET /locations` - Retrieves all locations from the first page.

    - `GET /locations?page=2` - Retrieves all locations from a specific page.

    - `GET /locations`

      - Parameters:

        - `name` (optional) - Filters locations by name.

        - `type` (optional) - Filters locations by type.

        - `dimension` (optional) - Filters locations by dimension.

        - `sort` (optional) - Sorts locations by name (`NAME_ASC`, `NAME_DESC`), type (`TYPE_ASC`, `TYPE_DESC`), or dimension (`DIMENSION_ASC`, `DIMENSION_DESC`).

    - `GET /locations/{id}` - Retrieves a specific location by ID.

- **Users**

    - `POST /users` - Registers a user by ID.

    - `PUT /users/{id}` - Fully updates user data.

    - `PATCH /users/{id}` - Partially updates user data by ID.

    - `DELETE /users/{id}` - _(soft delete)_ Deletes the user by ID.

- **Favorites**

    - `POST /favorites` - Registers a favorite and associates it with a user.

    - `GET /favorites/{userId}` - Retrieves all favorites for a specific user.

      - Parameters:

        - `page` (optional, default: 0) - The page number to retrieve.

        - `size` (optional, default: 10) - The number of items per page.

        - `sort` (optional, default: "asc") - Sorts by ID in ascending or descending order.

    - `DELETE /favorites/{userId}/{favoriteId}` - Removes a specific favorite for a user.

    - `DELETE /favorites/{userId}` - Removes all favorites for a user.

### Swagger Documentation

The API documentation is available via Swagger. You can access it by navigating to the following URL after running the application: `http://localhost:8080/swagger-ui/index.html`

This documentation provides a detailed description of all available endpoints, their parameters, and responses, making it easier to understand and interact with the API.

## Contributing

We welcome contributions from the open-source community. If you have any ideas, bug fixes, or feature requests, feel free to submit a pull request.


## Roadmap

- [x] Implement the remaining endpoints.

- [x] Implement the remaining users and favorites operations.

- [x] Implement the remaining features.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.

### References

- [Java 21 Documentation](https://docs.oracle.com/en/java/javase/21/)

- [Spring Boot](https://spring.io/projects/spring-boot)

- [Lombok](https://projectlombok.org/)