Anypoint Platform Development: API Design with RAML

2 days
Instructor-led
Level 1

Summary

This course is for API designers, developers, and architects who want to get hands-on experience creating well-designed, modular API definitions using RAML 1.0 and Anypoint Platform™.

Get a datasheet for the course here.

Objectives

At the end of this course, students should 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.
Document and 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.

Prerequisites

Getting Started with Anypoint Platform

Setup requirements

A computer with a minimum screen resolution of 1024x768
Unrestricted internet access to port 80 (with > 5Mbps download and > 2Mbps upload)
The latest version of Chrome, Safari, Firefox, or Edge
An Anypoint Platform account

Get a detailed setup document here.

PART 1: Designing APIs
Module 1: Introducing RESTful API design	Review AnyPoint Platform as it pertains to API design Describe the architecture of REST APIs List the rules for enforcing REST principles in APIs
Module 2: Translating functional requirements for APIs	Identify different categories and actions for REST APIs Translate categories to resources Select HTTP methods to support the actions on the categories

PART 2: Defining APIs with the RESTful API Modeling Language (RAML)
Module 3: Defining API resources and methods	Describe API specification languages used to create API definitions Use API Designer to create RAML API definitions Define resources and methods in RAML API definitions
Module 4: Specifying responses to REST API calls	Create HTTP method responses Use status codes in HTTP responses Add error handling and caching information to HTTP responses Select and specify the types of content returned in HTTP responses
Module 5: Modeling data	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
Module 6: Documenting and testing APIs	Add documentation and description nodes to API definitions Use the mocking service to create API endpoints Use the API console to test API endpoints
Module 7: Making APIs discoverable	Publish API specifications and fragments to Anypoint Exchange for discovery Create API portals for learning about and testing APIs in Anypoint Exchange Customize public portals with themes Gather feedback from API consumers
Module 8: Reusing patterns	Create and reference resource types for reusability Use traits to modularize methods Use libraries for greater API composability
Module 9: Securing and governing APIs	Define API security requirements Use security schemes to apply resource-level and method-level policies Define custom security schemes for APIs Apply an OAuth2.0 external provider policy to resource methods
Module 10: Enhancing API responses by using hypermedia	Describe hypermedia Simplify API discoverability and enhance responses using hypermedia Modify API definitions to generate state-specific client responses
Module 11: Versioning APIs	Explain when and when not to version APIs Describe the methods of versioning APIs Document changes in new API versions using API portals Deprecate old API versions

Instructor-led course

Attend a live course online or in-person at select locations.

Show schedule

Region

Language

16 available courses

There are no courses currently available. Adjust your filter settings to expand your search.

Japanese course links can be found in the Summary section for the course, where available.

10 Oct 2022 - 11 Oct 2022

10:00 AM - 6:00 PM AEDT

6.00 MTC or $ 1,500.00

English

Scott Silbernick

Session

17 Oct 2022 - 18 Oct 2022

8:00 AM - 4:00 PM PDT

6.00 MTC or $ 1,500.00

English

Vincent Lowe

Session

31 Oct 2022 - 01 Nov 2022

9:00 AM - 5:00 PM CET

6.00 MTC or $ 1,500.00

English

Max Golov

Session

07 Nov 2022 - 08 Nov 2022

8:00 AM - 4:00 PM EST

6.00 MTC or $ 1,500.00

English

Matthew Thurmaier

Session

14 Nov 2022 - 15 Nov 2022

9:00 AM - 5:00 PM CET

6.00 MTC or $ 1,500.00

English

Tricia Hammann

Session

21 Nov 2022 - 22 Nov 2022

9:00 AM - 5:00 PM AEDT

6.00 MTC or $ 1,500.00

English

Wayne Cook

Session

29 Nov 2022 - 30 Nov 2022

8:00 AM - 4:00 PM PST

6.00 MTC or $ 1,500.00

English

James Parkes

Session

12 Dec 2022 - 13 Dec 2022

9:00 AM - 5:00 PM CET

6.00 MTC or $ 1,500.00

English

Tricia Hammann

Session

12 Dec 2022 - 13 Dec 2022

8:00 AM - 4:00 PM EST

6.00 MTC or $ 1,500.00

English

Matthew Thurmaier

Session

03 Jan 2023 - 04 Jan 2023

9:00 AM - 5:00 PM CET

6.00 MTC or $ 1,500.00

English

Alex Theedom

Session

09 Jan 2023 - 10 Jan 2023

10:00 AM - 6:00 PM AEDT

6.00 MTC or $ 1,500.00

English

Scott Silbernick

Session

23 Jan 2023 - 24 Jan 2023

9:00 AM - 5:00 PM CET

6.00 MTC or $ 1,500.00

English

Andres Cespedes Morales

Session

13 Feb 2023 - 14 Feb 2023

8:00 AM - 4:00 PM PST

6.00 MTC or $ 1,500.00

English

Vincent Lowe

Session

27 Feb 2023 - 28 Feb 2023

8:00 AM - 4:00 PM EST

6.00 MTC or $ 1,500.00

English

Matthew Thurmaier

Session

14 Mar 2023 - 15 Mar 2023

8:00 AM - 4:00 PM PDT

6.00 MTC or $ 1,500.00

English

Vincent Lowe

Session

27 Mar 2023 - 28 Mar 2023

8:00 AM - 4:00 PM EDT

6.00 MTC or $ 1,500.00

English

Mansi Shanbhag

Session

Private training

Schedule a private training for six or more students online or onsite at your office.

Request a quote

Anypoint Platform Development: API Design with RAML

Summary

Objectives

Prerequisites

Setup requirements

Instructor-led course

Private training

Training resources

Community

Developer resources