Giter VIP home page Giter VIP logo

bookinterviewproject's Introduction

book-app-interview-project-api

Instructions

Setup Guidelines

  1. clone the repository using the code below

    git clone https://github.com/OluwasegunA/bookInterviewProject.git

  2. create a branch for test on your system and on the repository online

  3. checkout to your newly created branch

  4. build the project.

  5. create your application-dev.properties file using the application-test.properties as a sample

  6. edit the application-dev.properties file by replacing port,username,db and password to your own mysql connection and database details

  7. create your sql database using the database name from 5. above e.g "interview_project_db"

  8. You can check implemented API endpoints with the swagger UI configured in the app with http://localhost:8080/swagger-ui/#/ after running the app

  9. All API end points use the BaseResponse object as thier response payload, set the status code, description and data where necessary. errors gotten from exceptions would be put in the errors object during runtime. see example response from getting the user types below

    {
        "statusCode": 200,
        "description": "user types found succesfully",
        "data": [
            {
            "id": 1,
            "name": "Member"
            },
            {
            "id": 2,
            "name": "Guest"
            }
        ],
        "errors": null
    }
    
    
  10. setting HttpServletResponse.SC_OK (200) as the statusCode in the response payload for all successfull and HttpServletResponse.SC_BAD_REQUEST (400) for all failed operations. only uses HttpServletResponse.SC_INTERNAL_SERVER_ERROR (500) when you try to catch an internal server error during an operation.

bookinterviewproject's People

Watchers

OluwasegunA avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.