Date: Fri, 29 Mar 2024 10:34:22 -0500 (CDT) Message-ID: <1571632298.30447.1711726462073@PUBEDFIPRDWEB5.public.local> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_30446_499555736.1711726462071" ------=_Part_30446_499555736.1711726462071 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
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.2 is based on version 1.2 of the Swagge=
r specification.1 Java and .NET clients have been explicitly customized for us=
e with the Ed-Fi ODS / API, but the Swagger Codegen p=
roject supports generating clients for additional languages if your client =
will be written in Ruby, Python, PHP, or some other language.
The links below provide step-by-step guidance for the C# and Java flavor= s 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 ev= en if you haven't obtained a key / secret from another platfor= m host. A technical overview of the generated code can be found in t= he SDK Reference section of= this documentation.
For developers that have the full ODS / API development environment conf= igured, the How T= o: Generate the API SDK for C# - The Easy Way article describes an alte= rnative approach to generating the API SDK for C#.
1 In January 2016, the Swagger spe= cification changed its name to the OpenAPI specification. As of this releas= e, the Swagger toolset hasn't changed its identity, and this release of the= Ed-Fi ODS / API still relies on version 1.2 of the Swagger specification, = so we're sticking with the old name for now.
Find out more about how to develop client applications for an Ed-Fi= ODS / API v2.2 platform: