Code Monkey home page Code Monkey logo

coretask's Introduction

CoreTask

Completed task for the Core PHP/GO position.

Instructions

To run the project Docker needs to be installed within the system.

Steps:

  1. Download the project from the Github.
  2. Open the terminal within the downloaded project folder.
  3. Type:
  docker compose up
  1. Wait until Docker finishes executing the command.

RESTful API

Within this project there are 6 available RESTful endpoints.

These enpoints are:

  POST http://127.0.0.1/orders 

Used to create a new order.

Required parameters within the request body - user_id, title, email.

API call

 POST http://127.0.0.1/order/product 

Used to assign a product to the order.

Required parameters within the request body - order_id, product_id.

API call

  GET http://127.0.0.1/orders 

Used to list all orders and filter them by user_id, email and sort by created_at.

Optional parameters within the URI - user_id, email, sort.

API call

  GET http://127.0.0.1/order/{order_id}

Used to show specific order with assigned products.

Required parameter within the URI - order_id.

API call

  PATCH http://127.0.0.1/product/{product_id}

Used to update product name or amount.

Required parameter within the URI - product_id.

Optional parameters within the request body - name, amount.

API call

  DELETE http://127.0.0.1/order/{order_id}/product/{product_id}

Used to delete assigned product from order.

Required parameters within the URI - order_id, product_id.

API call

Author

coretask's People

Contributors

dominykasjurkus avatar

Watchers

 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.