🐻An enhanced learning experience is coming soon! Registrations for expert-led classes will be paused temporarily from 11:00 PM PST on April 30, 2024, until 4:00 PM PST on May 6, 2024. Learn more. Need help with a class? Reach out to Trailhead Help.

Job Role

Architect, Developer

Duration

In-Person: 2 Full Day(s)
Virtual: 2 Full Day(s) or 4 Half Day(s)
Save as PDF
Question, feedback or help

Overview

Who should take this course?


This course is designed for API designers, developers, and architects who are responsible for designing modular APIs on Anypoint Platform using RAML 1.0. Students should have foundational knowledge of Anypoint Platform and a basic understanding of how to build no-code APIs.


Note: Students using their own computer are expected to follow the steps outlined in this Computer Setup Guide.


When you complete this course, you will be able to:


  • Translate functional design requirements into API resources and methods.
  • Use API Designer to create API specifications.
  • Define API resources, methods, parameters, and responses using RAML.
  • Model data in APIs using datatypes.
  • Test APIs.
  • Make APIs discoverable.
  • Minimize repetition in APIs using resource types and traits.
  • Modularize APIs using libraries, overlays, and extensions.
  • Specify API security schemes.
  • Enhance API responses using hypermedia.
  • Version APIs.

Class Registration

Lessons and Topics

RESTful API Design

  • Connect AnyPoint Platform to API Design
  • Describe REST APIs Architecture
  • Enforce REST Principles in APIs

 

Functional Requirements for APIs

  • Identify Categories and Actions for REST APIs
  • Translate Categories to Resources
  • Select HTTP Methods To Support Actions on Categories

 

API Resources and Methods

  • Describe API Specification Languages that Create API Definitions
  • Use API Designer To Create RAML API Definitions
  • Define Resources and Methods in RAML API Definitions

 

Responses to REST API Calls

  • Create HTTP Method Responses
  • Use Status Codes in HTTP Responses
  • Add Error Handling and Caching to HTTP Responses
  • Specify Types of Content Returned in HTTP Responses

 

Data Modeling

  • Identify Datatypes and Attributes used in Resource Methods
  • Create Datatype Fragments
  • Set Request and Response Body Types to Datatypes
  • Create Examples for Datatype Fragments
  • Include Examples in Datatype Fragments

 

API Testing

  • Add Documentation and Description Nodes to API Definitions
  • Use Mocking Service To create API Endpoints
  • Use API Console To Test API Endpoints

 

API Discoverability

  • Publish API Specifications and Fragments to Anypoint Exchange
  • Create API Portals To Learn About and Test APIs in Anypoint Exchange
  • Customize Public Portals with Themes
  • Gather Feedback from API Consumers

 

Pattern Reuse

  • Create and Reference Resource Types for Reusability
  • Modularize Methods with Traits
  • Use Libraries for Greater API Composability

 

API Security and Governance

  • Define API Security Requirements
  • Apply Resource-Level and Method-Level Policies
  • Build Custom Security Scheme for APIs
  • Apply an OAuth 2.0 External Provider Rolicy to Resource Methods

 

Hypermedia and API Responses

  • Describe Hypermedia
  • Simplify API Discoverability and Enhance Responses Using Hypermedia
  • Modify API Definitions To Generate State-Specific Client Responses

 

API Versions

  • Explain When and When Not To Version APIs
  • Version APIs
  • Document Changes in New API Versions with API Portals
  • Deprecate Old API Versions