This set of Learning Paths outlines common scenarios for getting started creating an API in the API Platform - from initial set up of your API, to configuring and customizing the logic to managing and manipulating data as they flow through the API.
Creating APIs
Create an API facade (and an API proxy configuration) - includes
- Setting sever information for your API
- Managing API versions
- Adding API resources
- Handling API revisions
Configuring APIs
Enhance your app with third-party APIs - Twitter, Facebook, (maps), etc.
- Build a composite service with JavaScript
- Access data from an external service using service callout
Modify request/response headers
Conditionally execute logic based on request content
Customize API behavior based on error conditions
Paginate API responses
-
Can your API give developers just the information they need? Covers
-
Paginating objects returned from a database.
-
Optimizing for mobile apps by selecting just the information your app needs as a partial response
-
Managing API Payloads
Orchestrate multiple API calls into a single response
Store data temporarily for use by my policy or JavaScript
- Assign values to a variable using assign message - Populate a message with content previously extracted
- Extract content from messages - JSON, XML, etc.
- Extract data from a message using extract variable - glean data from the message and make it available as variables
- Build a composite service with JavaScript
Transform message formats - XML/JSON, SOAP/REST, etc.
- Convert XML to JSON
- Convert JSON to XML
- Review all transformation possiblities HERE
