raihahahan/decision-maker-api

Decision Maker Web API

A .Net 6 Web API project to help you make decisions.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Decision Maker API is a Web API created with .Net 6. It contains features such as CRUD, pagination, sorting and filtering. This is my first .Net project and is still incomplete.

Go to https://github.com/raihahahan/decision-maker-nextjs-client to see an example of a web client for this Web API. You are free to make use of this API to create your own client.

(back to top)

Features and Endpoints

• For a much clearer overview of the schema and endpoints, go to https://localhost:{port}/swagger/index.html.

Random Decision

• From a list of choices, randomly return a decision.

GET /api/RandomDecisionItems
POST /api/RandomDecisionItems
GET /api/RandomDecisionItems/{id}
PUT /api/RandomDecisionItems/{id}
DELETE /api/RandomDecisionItems/{id}
GET /api/RandomDecisionItems/{id}/decide

Weighted Decision

• From a list of choices, provide a list of criteria affecting your choice.
• For example, for a list of cars, some criteria may be budget, convenience, specs etc.
• Weigh how important each criteria is for each choice.

GET /api/WeightedDecisionItems
POST /api/WeightedDecisionItems
GET /api/WeightedDecisionItems/{id}
PUT /api/WeightedDecisionItems/{id}
DELETE /api/WeightedDecisionItems/{id}
POST /api/WeightedDecisionItems/{id}/decide

Conditional Decision (IN PROGRESS)

• From a list of choices, provide a list of conditions affecting your choice.
• For example, for a list of commuting method (e.g. bicycle, public transport, private transport), some conditions may be "Rainy weather", "Must report to work earlier" etc. And for each condition, there are two lists, include and exclude, each containing a list of choices to include and exclude respectively if the given condition is true.

GET /api/ConditionalDecisionItems
POST /api/ConditionalDecisionItems
GET /api/ConditionalDecisionItems/{id}
PUT /api/ConditionalDecisionItems/{id}
DELETE /api/ConditionalDecisionItems/{id}
POST /api/ConditionalDecisionItems/{id}/decide

(back to top)

Getting Started

Prerequisites

You will need to install dotnet. See https://dotnet.microsoft.com/en-us/.

Installation

1. Clone the repo

   git clone https://github.com/raihahahan/decision-maker-api.git

2. Restore the dependencies and tools of the project.

   dotnet restore

3. Start the project.

   dotnet run

(back to top)

Roadmap

• CRUD for each feature.
• Search, filters, pagination.
• Unit testing.
• Authentication to save the decisions into an account.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Email: [email protected] Website: https://mraihan.vercel.app

(back to top)

Acknowledgments

• Microsoft Learn: Create a Web API
• ReadMe template

(back to top)

decision-maker-api's Issues

Fix Conditional Decision Edit

• edit should work as expected for conditional decision