Skip to content

lobophf/simple-quotes-API

Repository files navigation

This simple API give to you a way to fetch quotations into JSON format.

To set up and run the server, you need to create a MySQL database and add a file /src/main/resources/application.properties which the following content. Don't forget to replace fields like database name, username, and password.

spring.jpa.hibernate.ddl-auto=update
spring.datasource.url=jdbc:mysql://${MYSQL_HOST:localhost}:3306/{database_name}
spring.datasource.username={user_name}
spring.datasource.password={password}
spring.datasource.driver-class-name =com.mysql.jdbc.Driver
#spring.jpa.show-sql: true

Now, access the root project and execute the command below to download the Gradle locally.

gradle wrapper

Then, run this Gradle task:

./gradlew bootRun

REST API Methods

You might want to access the endpoints using the following cURL commands.

GET

http://localhost:8080/api/v1/simplequotations
http://localhost:8080/api/v1/simplequotations/{id}
http://localhost:8080/api/v1/simplequotations/random

POST

curl -X POST -H "Content-Type: application/json" \
	-d '{
		"author": "Erik Naggum",
		"year": "1993",
		"quotationContent": "Life is too long to know C++ well.",
		"urlImgAssociatedWithIt": ""
	    }' \
	    http://localhost:8080/api/v1/simplequotations

PUT

curl -X PUT -H "Content-Type: application/json" \
	-d '{
		"author": "Robert C. Martin",
		"year": "1993",
		"quotationContent": "Redundant comments are just places to collect lies and misinformation.",
		"urlImgAssociatedWithIt": ""
	}' \
	http://localhost:8080/api/v1/simplequotations/1

DELETE

curl -X DELETE http://localhost:8080/api/v1/simplequotations/1

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages