Skip to content

williamniemiec/nshopping-api

Repository files navigation

nShopping API

API built with Spring Framework for a shopping system.

Java compatibility Release License

Deploy


❇ Introduction

nShopping API is an API built with Spring Framework for a simple shopping system. This application was made for the sole purpose of learning the Spring framework better. You can interact with the project through the Heroku platform (click here to access).

Login information

Email Password
william@email.com 123

⚠ Warnings

The hosting service Heroku may have a certain delay (~ 1 min) for uploading the application so the loading of the website may have a certain delay.

📖 Documentation

See here the OpenAPI documentation.

✔ Requiremens

🚩 Changelog

Details about each version are documented in the releases section.

🗺 Project structure

architecture

📁 Files

/

Name Type Description
docs Directory Documentation files
src Directory Application and test files

/src

Name Type Description
main Directory Application files
test Directory Test files

/src/main

Name Type Description
resources Directory Static files
java Directory Source files

/src/main/java/wniemiec/api/nshopping

Name Type Description
config Directory Configuration classes
controllers Directory Classes that handle with HTTP requests and responses
domain Directory Application domain classes
dto Directory Data transfer object classes
filters Directory Classes that intercept the HTTP requests and responses
repositories Directory Classes that handle with database
security Directory Classes responsible for authentication
services Directory Classes responsible for providing data
App.java File Application entry point