-
Notifications
You must be signed in to change notification settings - Fork 14
Getting Started
Steve Ives edited this page May 28, 2020
·
12 revisions
If you are new to Harmony Core, the following topics will help you to become familiar with the basic requirements, tools, and techniques that you will need to know about in order to get started:
-
- This topic discusses the various software tools, SDK's and other things that you will need to get started with Harmony Core development.
-
- This topic provides an overview of the solution templates that we provide to allow you to create pre-configured Visual Studio development environments quickly and easily.
-
- This topic provides you with a basic working knowledge of a software tool called CodeGen. Most Harmony Core development environments rely on CodeGen to automatically generate much of the of source code needed to build OData and other types of web services. You don't need to be a CodeGen expert to be successful with Harmony Core development, but it helps to have a basic understanding of how it works.
-
- Much of the code that is generated when building Harmony Core OData services is based on meta-data in a Synergy repository. This topic explains how to go about setting up your repository for use with Harmony Core.
-
- Harmony Core web services are exposed via the secure HTTPS protocol, so an SSL certificate is required in order to facilitate the secure encryption of data. For development purposes, the .NET Core environment provides tools that make it easy to create and use "self-signed certificates". This topic explains this subject in more detail, and walks you through the process of creating and trusting a self-signed SSL certificate.
-
- Harmony Core is built on top of several industry-standard open-source platforms and libraries. It's not necessary to know all of these technologies in detail, but if you want to get more involved, and start to really understand the internals of how everything fits together and works, then this topic provides links to the documentation for all of those core dependencies.
-
- 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 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