Skip to Scheduled Dates
Course Overview
Discover how to translate functional design requirements into modular, reusable API definitions with Anypoint Platform. In this 2-day instructor-led course, learn about REST architecture and principles, HTTP methods, Application Programming Interface (API) design, and RESTful API Modeling Language (RAML). Use API Designer to create API specifications, define API resources, methods, parameters, and responses, model data in APIs with datatypes, and document and test APIs. Make APIs discoverable and accessible to your developers in order to standardize the way your customers and employees interact with your data.
Who Should Attend
- This course is designed for API designers, developers, and architects who are responsible for designing modular APIs on Anypoint Platform using RAML 1.0.
Course Objectives
- 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
Course Outline
1. RESTful API Design
- Connect AnyPoint Platform to API Design
- Describe REST APIs Architecture
- Enforce REST Principles in APIs
2. Functional Requirements for APIs
- Identify Categories and Actions for REST APIs
- Translate Categories to Resources
- Select HTTP Methods To Support Actions on Categories
3. 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
4. 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
5. 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
6. API Testing
- Add Documentation and Description Nodes to API Definitions
- Use Mocking Service To create API Endpoints
- Use API Console To Test API Endpoints
7. 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
8. Pattern Reuse
- Create and Reference Resource Types for Reusability
- Modularize Methods with Traits
- Use Libraries for Greater API Composability
9. 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
10. Hypermedia and API Responses
- Describe Hypermedia
- Simplify API Discoverability and Enhance Responses Using Hypermedia
- Modify API Definitions To Generate State-Specific Client Responses
11. 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