API for fitability:tm:

This provides APIs for all fitability:tm: apps.

Prerequisites

This repository contains all API apps written in different languages including C# and Java. All API apps are running on Azure Functions. Therefore, setting up the development environment to locally run all Azure Functions apps is critical.

Depending on your developer expertise, you may be required to install some or all of the following IDE and tools to locally develop API applications.

For .NET

For .NET-based API apps, you must install the following IDE and SDK.

• .NET 6 SDK
• Visual Studio
• Visual Studio Code
• Visual Studio Code Extension: C#
• Visual Studio Code Extension: Azure Tools
• Azure Functions Core Tools
• Azurite: Local Azure Storage Emulator

If you are new to .NET-based Azure Functions app, please read this doc, Develop C# class library functions using Azure Functions, first and get yourself used to it.

For Java

For Java-based API apps, you must install the following IDE and SDK.

• Microsoft Build of OpenJDK 17
• Apache Maven
• Azure Functions Core Tools
• Azurite: Local Azure Storage Emulator

There are many options for you to choose an IDE. If you want to use JetBrains' IntelliJ IDEA:

• IntelliJ IDEA
• IntelliJ IDEA Plugin: Azure Toolkit for IntelliJ

If you prefer using Visual Studio Code:

• Visual Studio Code
• Visual Studio Code Extension: Extension Pack for Java

If you are new to Java-based Azure Functions app, please read this doc, Azure Functions Java developer guide, first and get yourself used to it.

NOTE: Although the document above says that the Azure Functions v4 runtime supports both Java 8 and 11, our APIs are targeting Java 8, due to some limitations as of January 2022. We will continue to investigate when to migrate to Jave 11 or higher.

For Azure Resources

For Azure resources, you are strongly recommended to install the following IDE, extensions and tools.

• Free Azure Account for 30 Days
• Visual Studio Code
• Visual Studio Code Extension: Bicep
• PowerShell
• Azure CLI
• Azure Storage Explorer

Getting Started

TBD

Known Issues

IntelliJ IDEA on Mac

• Starting the IntelliJ IDEA instance from command-line is strongly recommended, idea .; otherwise the Azure Functions Core Tools will not be properly loaded.
• Running a Java function app keeps the port 7071 even after you stop the app. It's a bug of IntelliJ IDEA. In the meantime, you should manually kill the process by running the bash script, kill-process.sh.

Credits

• Icons made by Freepik from www.flaticon.com