Skip to content

Latest commit

 

History

History
202 lines (146 loc) · 7.58 KB

README.md

File metadata and controls

202 lines (146 loc) · 7.58 KB
Raw

easyTradeCreditCardOrderService

A java service that lets the user order/remove a credit card for their account. All the manufacturing and delivery will be handled by an unmonitored third party service. The card information is stored in the database.

Technologies used

  • Java 17
  • Docker
  • MSSql

Local build instructions

docker build -t easytradecreditcardorderservice .
docker run -d -p 8091:8080 --name credit-card-order-service -e THIRD_PARTY_SERVICE_HOSTANDPORT=third-party-service:8080 -e WORK_DELAY=300 -e WORK_RATE=900 -e MSSQL_CONNECTIONSTRING="jdbc:sqlserver:https://db:1433;database=TradeManagement;user=sa;password=yourStrong(!)Password;encrypt=false;trustServerCertificate=false;loginTimeout=30;" -e PROXY_PREFIX=credit-card-order-service

If you want the service to work properly, you should try setting these ENV variables:

Name Description Default
THIRD_PARTY_SERVICE_HOSTANDPORT the host and port where the third party service can be found third-party-service:8080
WORK_DELAY how long is the initial delay in seconds 300
WORK_RATE how often does the service try to process new request in seconds 900
MSSQL_CONNECTIONSTRING database connection string jdbc:sqlserver:https://db:1433;database=TradeManagement;user=sa;password=yourStrong(!)Password;encrypt=false;trustServerCertificate=false;loginTimeout=30;
PROXY_PREFIX prefix identifying service in nginx credit-card-order-service

Endpoints or logic

Swagger

Swagger endpoint is available at:

# when deployed locally
https://localhost/swagger-ui/index.html

# when deployed with compose.dev.yaml
https://localhost:8091/swagger-ui/index.html

# when deployed with k8s
https://SOMEWHERE/credit-card-order-service/swagger-ui/index.html

Version endpoint is available at /version

Api v1

POST /v1/orders (Creates a new credit card order)

Parameters
name type data type description
accountId required int Account for which we create a credit card
email required string Email to which notifications can be sent
name required string Name to be printed on the card
shippingAddress required string Address where the finished card will be shipped
cardLevel required string Type of card. Can be one of: silver, gold, platinum
Example cURL
 curl -X 'POST' \
  'https://{IP_ADDRESS}/credit-card-order-service/v1/orders' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "accountId": 15,
  "email": "[email protected]",
  "name": "John Bear",
  "shippingAddress": "Milky Way 13",
  "cardLevel": "silver"
}'
Example of JSON body
{
  "accountId": 15,
  "email": "[email protected]",
  "name": "John Bear",
  "shippingAddress": "Milky Way 13",
  "cardLevel": "silver"
}

POST /v1/orders/{orderId}/status (Update the credit card order status)

Parameters
name type data type description
orderId required string - GUID The ID of the credit card order
type required string Type of status update
timestamp required timestamp Date and time timestamp
details optional a JSON object Necessary details for the operation - depends on the type
Example cURL
 curl -X 'POST' \
  'https://{IP_ADDRESS}/credit-card-order-service/v1/orders/b0404285-41ca-4748-a8d9-8a104a0a9d08/status' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "orderId": "b0404285-41ca-4748-a8d9-8a104a0a9d08",
  "type": "card_delivered",
  "timestamp": "2023-07-28T14:51:59.847Z",
  "details": {}
}'
Example of JSON body
{
  "orderId": "b0404285-41ca-4748-a8d9-8a104a0a9d08",
  "type": "card_delivered",
  "timestamp": "2023-07-28T14:51:59.847Z",
  "details": {}
}

GET /v1/orders/{orderId}/shipping-address (Get shipping address of gives credit card order by its ID)

Parameters
name type data type description
orderId required string - GUID The ID of the credit card order
Example cURL
 curl -X 'GET' \
  'https://{IP_ADDRESS}/credit-card-order-service/v1/orders/b0404285-41ca-4748-a8d9-8a104a0a9d08/shipping-address' \
  -H 'accept: application/json'

GET /v1/orders/{accountId}/status (Get the status history of credit card order by account ID)

Parameters
name type data type description
accountId required int The ID of the account
Example cURL
 curl -X 'GET' \
  'https://{IP_ADDRESS}/credit-card-order-service/v1/orders/17/status' \
  -H 'accept: application/json'

GET /v1/orders/{accountId}/status/latest (Get the latest status of credit card order by account ID)

Parameters
name type data type description
accountId required int The ID of the account
Example cURL
 curl -X 'GET' \
  'https://{IP_ADDRESS}/credit-card-order-service/v1/orders/17/status/latest' \
  -H 'accept: application/json'

DELETE /v1/orders/{accountId} (Delete the credit card order by account ID)

Parameters
name type data type description
accountId required int The ID of the account
Example cURL
 curl -X 'DELETE' \
  'https://{IP_ADDRESS}/credit-card-order-service/v1/orders/17' \
  -H 'accept: application/json'