Giter Site home page Giter Site logo

calculator_api's Introduction

Calculator API

This is a simple calculator API built with .NET Core Web API, which supports basic arithmetic operations (+, -, *, /) and JWT authentication for secure access. The API also uses FluentValidation for input validation and Serilog for logging HTTP requests and responses to a file.

Getting Started

####Prerequisites To build and run the API, you need the following installed on your machine:

  • .NET 7 SDK

####Installing

  • Clone the repository to your local machine.

  • Open a command prompt or terminal window and navigate to the root directory of the project.

  • Run the following command to build the project: dotnet build

  • Run the following command to start the API: dotnet run

The API should now be running and listening for requests.

###Usage

####Authentication The API uses JWT authentication for secure access.

  • To register a user, you need to send a POST request to the /api/auth/register endpoint with a username and password.

  • Then To authenticate, you need to send a POST request to the /api/auth/login endpoint with a valid username and password. The endpoint returns a JWT token that you need to include in the other API requests related to calculator API.

####Calculation To perform a calculation, send a POST request to the /{arithmatic operation} endpoint with the two operands and operator in the request body. You need to include the JWT token obtained from the authentication request in the Authorization header.

#####Request POST /api/calculate HTTP/1.1 Content-Type: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

{
  "leftoperand": 10,
  "rightoperand": 5
}

#####Response HTTP/1.1 200 OK Content-Type: application/json

{
  "result": 15
}

Repeat the same for the other endpoints as well

Thank you.

Copyrights @Benuka Withanage [email protected]

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.