API Design & Implementation Guidelines

This section provides design guidelines for an Ed-Fi representational state transfer (REST) Application Programming Interface (API). These guidelines describe the properties to which an API specification and related implementation must adhere in order to be considered aligned to Ed-Fi technology standards. They are guidelines only. They do not describe a specific implementation or particular API specification. Where helpful, a rationale for specific guidelines is also provided.

Contents