/ContactAPI

a simple API where a user can get a quick overview over all contacts resources like person, skills

Primary LanguageJava

ContactsAPI

a simple API where a user can get a quick overview of all contact resources like person, skills.

a restful API created using Spring Boot. We used PostgreSQL as the relational database and jpa to interact with it.

We also used JSON Web Token (JWT) to add authentication. By using JWT, we can protect certain endpoints and ensure that the user must be logged in to access them.

Configuration and installation

  1. Install pgadmin

  2. Clone the repo from GitHub git clone https://github.com/Tshili/ContactAPI.git

  3. In this application, we use the default database ("postgres"), it's a bad practice but we don't want to waste time to create a sql file to generate the database

  4. After running the application. Swagger is available at http://localhost:8080/swagger-ui/index.html#/. You have to create a user and log in. You will have to use the authentication token in order to use the endpoints