API Structure and Conventions

From Ocean Framework Documentation Wiki
Jump to: navigation, search
General API Considerations
Protocol, Encoding, and Constraints
Get–Ignore–Follow
HTTP Methods
Date and Time
API Versioning
Unified URI structure
Public URIs
Resource Representations
General Resource Representation
Receiving Resources
Sending Resources
Resource Representation Scope
The Importance of Hyperlinks
Hypermedia
Hyperlink URIs are Opaque
Resource API Documentation
Resource Collections
Minimal Collection Format
Unpaged Collection Format
Paged Collection Format
Collection Searches
Authentication and Authorisation
Scalability
Flow
Web Clients
Design for Full Exposure
Requests to Services
HTTP Headers
HTTP Body
Substandard Browsers
Responses from Services
Example Headers
HTTP Status Codes
Error information
Partial Table Access: app and context
Examples