This version of the Ed-Fi ODS / API is no longer supported. See the Ed-Fi Technology Version Index for a link to the latest version.

 

Using Code Generation to Create an SDK

Owned by Ian Christopher
Last updated: Oct 29, 2016
1 min read

Previous Version

This is a previous version of the Ed-Fi ODS / API. Visit the Ed-Fi Tech Docs home page for a link to the current version, or the Ed-Fi Technology Version Index for links to all versions. 

Using code generation tools, much of the data access code required for a client can be created automatically using metadata exposed by an Ed-Fi ODS / API platform host.

The metadata in the ODS / API v2.0 is based on version 1.2 of the Swagger specification. Java and .NET clients have been explicitly customized for use with the Ed-Fi ODS / API, but the Swagger CodeGen project supports generating clients for additional languages if your client will be written in Ruby, Python, PHP, or some other language.

Step-by-Step Instructions

The links below provide step-by-step guidance for the C# and Java flavors of the customized code generation tools:

The step-by-step instructions reference a publicly available instance of an Ed-Fi ODS / API hosted by the Ed-Fi Alliance, so you can get started even if you haven't obtained a key / secret from another platform host. A technical overview of the generated code can be found in the SDK Reference section of this documentation.