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

https://github.com/duduxs/osworks-api

🖖 API Rest using MySQL and Spring Web. It was developed during the Spring Rest Immersion from AlgaWork.
https://github.com/duduxs/osworks-api

api flyway insomnia jpa model-mapper mysql project spring

Last synced: about 1 month ago
JSON representation

🖖 API Rest using MySQL and Spring Web. It was developed during the Spring Rest Immersion from AlgaWork.

Awesome Lists containing this project

README

          


The main idea is created a API Rest based in the UML Diagram below.


Technologies   |   
How To Use   |   
How To Contribute   |   


Insomnia
UML

## :rocket: Technologies

This API was developed with the following technologies:

- [Java](https://www.java.com/pt_BR/)
- [MySQL](https://www.mysql.com/)
- [Model Mapper](http://modelmapper.org/)
- [Flyway](https://flywaydb.org/)
- [JPA](https://www.devmedia.com.br/introducao-a-jpa-java-persistence-api/28173)
- [Spring(Boot,Data,Web)](https://spring.io/projects/spring-framework)
- [Eclipse](https://www.eclipse.org/downloads/)
- [Insomnia](https://insomnia.rest/download/)

## :information_source: How to use

To clone and run this application, you'll need [Git](https://git-scm.com), - [Insomnia](https://insomnia.rest/download/) or [Postman](https://www.postman.com/) From your command line:

```bash
# Clone this repository
$ git clone https://github.com/Duduxs/osworks-api

# Get the url

# Start the server -> OsworksApiApplication.java

# Go to Postman or Insomnia and use the endpoints. [http://localhost:8080/...]

# [Port:8080] (You can change it going to application.properties file)

```

## :thumbsup: How To Contribute

- Make a fork;
- Create a branch with your feature: `git checkout -b my-feature`;
- Commit changes: `git commit -m 'feat: My new feature'`;
- Make a push to your branch: `git push origin my-feature`.

---


Made by Eduardo José 😆 Contact me!