crolopez / invoice-api-aspnet

Simple API REST to manage invoices with the purpose of gaining knowledge about ASP.NET.

Invoice API

Simple API REST to manage invoices with the purpose of gaining knowledge about ASP.NET.

Prerequisites

• .NET 5.0 SDK

Configuration

To configure the API you have to update the appsetting file with the following values:

Field	Description
DatabaseConnectionString (required)	Connection string from SQL Database Server
CurrencyConverterKey (required)	API key from https://free.currconv.com service

  "Config": {
    "CurrencyConverterKey": "XXXX",
    "DatabaseConnectionString": "YYYY"
  }

How to deploy

Just execute:

dotnet run --project InvoiceApi # Includes the building step

You can check an Azure Pipeline example about how to generate the artifact here.

RESTful API

Register an invoice

Request:

POST /api/invoice/

curl -i -H 'Content-Type: application/json' https://localhost:5001/api/invoice/ \
-d '{ "invoiceId": "891248192B", "supplier": "Fake supplier", "dateIssued": "2021-01-27T17:16:40", "currency": "EUR", "amount": 1000.00, "description": "New projector for confenrece room" }'

Response:

{
    "data": [
        {
            "id": "891248192B",
            "type": "invoice",
            "attributes": {
                "invoiceId": "891248192B",
                "supplier": "Fake supplier",
                "dateIssued": "2021-01-27T17:16:40",
                "currency": "EUR",
                "amount": 1000,
                "description": "New projector for confenrece room"
            }
        }
    ]
}

Get invoices

Request:

GET /api/invoice

curl -i -H 'Content-Type: application/json' https://localhost:5001/api/invoice/'

Response:

{
    "data": [
        {
            "id": "891248192B",
            "type": "invoice",
            "attributes": {
                "invoiceId": "891248192B",
                "supplier": "Fake supplier",
                "dateIssued": "2021-01-27T17:16:40",
                "currency": "EUR",
                "amount": 1000,
                "description": "New projector for confenrece room"
            }
        },
        ...
    ]
}

Get an invoice

Request:

GET /api/invoice/<invoiceID>

curl -i -H 'Content-Type: application/json' https://localhost:5001/api/invoice/891248192B'

Response:

{
    "data": [
        {
            "id": "891248192B",
            "type": "invoice",
            "attributes": {
                "invoiceId": "891248192B",
                "supplier": "Fake supplier",
                "dateIssued": "2021-01-27T17:16:40",
                "currency": "EUR",
                "amount": 1000,
                "description": "New projector for confenrece room"
            }
        }
    ]
}

Delete an invoice

Request:

DELETE /api/invoice/<invoiceID>

curl -X DELETE -i -H 'Content-Type: application/json' https://localhost:5001/api/invoice/891248192B'

Response:

{
    "data": [
        {
            "id": "891248192B",
            "type": "invoice"
        }
    ]
}

Modify an invoice

Request:

PUT /api/invoice/<invoiceID>

curl -X PUT -i -H 'Content-Type: application/json' https://localhost:5001/api/invoice/891248192B \
-d '{ "invoiceId": "891248192B", "supplier": "Fake supplier", "dateIssued": "2021-01-27T17:16:40", "currency": "EUR", "amount": 1500.00, "description": "New table for confenrece room" }'

Response:

{
    "data": [
        {
            "id": "891248192B",
            "type": "invoice",
            "attributes": {
                "invoiceId": "891248192B",
                "supplier": "Fake supplier",
                "dateIssued": "2021-01-27T17:16:40",
                "currency": "EUR",
                "amount": 1500,
                "description": "New table for confenrece room"
            }
        }
    ]
}