-
Notifications
You must be signed in to change notification settings - Fork 14
Tutorials
To help you learn how to build Harmony Core services, we have developed several self-paced tutorials that will teach you everything from basic concepts to advanced techniques.
-
Tutorial 1: Building a Demo Service
Get a Harmony Core OData web service up and running really quickly by following this short tutorial. You will learn how to use the harmonydemo solution template to create a pre-configured demo environment that you can examine and explore.
-
Tutorial 2: Building a Service From Scratch
If you are looking for a lot more detail then this tutorial is for you. You will start by creating a bare-bones environment using the harmonycore solution template, and then you will build a comprehensive Harmony Core OData web service from scratch, step-by-step, in bite-sized pieces. Along the way we will explain the basic concepts, and how everything fits together. By the end of the tutorial you will have implemented much of the same functionality that the demo tutorial provided, but you will have the satisfaction of having built the service yourself! There won't be any Traditional Bridge functionality, but don't worry, you can learn how to implement that by following the Implementing Traditional Bridge tutorial.
-
Tutorial 3: Authentication via Custom Code
In this tutorial you will start with the Harmony Core service that you created during tutorial 1 or tutorial 2, and you will add code-based user authentication to the service. By code-based we mean that you will have the opportunity to provide custom code to determine which users can be authenticated, and which can not.
-
Tutorial 4: Implementing Traditional Bridge
So far it's all been about OData, but there is so much more that Harmony Core can do. In this tutorial we'll switch gears and start to consider code-centric services, where web service endpoints are backed not by automatically generated data access code, but by custom business logic that you write. There are several ways to do this, but in this tutorial we will focus on using Traditional Bridge, a mechanism that lets you leverage business logic written in traditional Synergy as part of your Harmony Core service.
- Tutorial 5: Incorporating Custom Code
- Tutorial 6: xfServerPlus Migration
- Tutorial 7: Authentication with an OAuth 2 Server
-
Tutorial 2: Building a Service from Scratch
- Creating a Basic Solution
- Enabling OData Support
- Configuring Self Hosting
- Entity Collection Endpoints
- API Documentation
- Single Entity Endpoints
- OData Query Support
- Alternate Key Endpoints
- Expanding Relations
- Postman Tests
- Supporting CRUD Operations
- Adding a Primary Key Factory
- Adding Create Endpoints
- Adding Upsert Endpoints
- Adding Patch Endpoints
- Adding Delete Endpoints
-
Harmony Core Code Generator
-
OData Aware Tools
-
Advanced Topics
- CLI Tool Customization
- Adapters
- API Versioning
- Authentication
- Authorization
- Collection Counts
- Customization File
- Custom Field Types
- Custom File Specs
- Custom Properties
- Customizing Generated Code
- Deploying to Linux
- Dynamic Call Protocol
- Environment Variables
- Field Security
- File I/O
- Improving AppSettings Processing
- Logging
- Optimistic Concurrency
- Multi-Tenancy
- Publishing in IIS
- Repeatable Unit Tests
- Stored Procedure Routing
- Suppressing OData Metadata
- Traditional Bridge
- Unit Testing
- EF Core Optimization
- Updating a Harmony Core Solution
- Updating to 3.1.90
- Creating a new Release
-
Background Information