eric-souzams/forum-api

This application is an API for a discussion forum on various topics and subjects, like the website Brainly.

Forum API

About   |    Preview   |    Technologies   |    Building   |    Contributing   

About

This application is an API for a discussion forum on various topics and subjects, like the website Brainly.

Preview

Matter

GET: http://localhost:8080/matters
POST: http://localhost:8080/matters

Author

GET: http://localhost:8080/author/{authorId}
POST: http://localhost:8080/author

Topic

GET: http://localhost:8080/topics
POST: http://localhost:8080/topics

PATCH: http://localhost:8080/topics/{topicId}
PATCH: http://localhost:8080/topics/{topicId}/close
PATCH: http://localhost:8080/topics/{topicId}/solve
PATCH: http://localhost:8080/topics/{topicId}/not-solve

GET: http://localhost:8080/topics/{topicId}/answers
POST: http://localhost:8080/topics/{topicId}/answers
POST: http://localhost:8080/topics/{topicId}/answers/{answerId}/like

Technologies

This project was developed using the following technologies:

• Java
• Spring Boot
• Spring Security
• Spring Data JPA
• Lombok

Building

You'll need Java 11+ and Maven installed on your computer in order to build this app.

$ git clone https://github.com/eric-souzams/forum-api.git
$ cd /forum-api
$ mvn spring-boot:run

Contributing

This repository is currently under development. If you want to contribute please fork the repository and get your hands dirty, and make the changes as you'd like and submit the Pull request.