Designing APIs Using Best Practices

Training information

Introduction

This training is for API designers, developers, and architects wishing to gain practical experience in creating modular API definitions using RAML/OAS and Anypoint Platform.

General information

Target Audience: Anyone involved in an API development project with Anypoint Platform. Prerequisites: None.

Target Competencies:

  • Design APIs based on the functional requirements of a digital product to be built.

  • Position REST APIs among common API formats.

  • Apply best practices for API design, documentation, and publication.

Learning Objectives:

  • Define API resources, methods, parameters, and responses using RAML.

  • Model data in APIs using data types.

  • Specify security schemes and manage versioning.

Program

Part 1: RESTful Design & RAML Foundations (7 Hours)

  • 1.1 REST Architecture & Design-First Approach: Mapping functional requirements to API capabilities, navigating the API lifecycle, and adopting a design-first mindset.

  • 1.2 RAML Definition & Data Modeling: Defining root resources, configuring HTTP methods and responses, and structuring reusable data types within the API Designer.

Part 2: Discovery, Security & Scalability (7 Hours)

  • 2.1 Testing, Mocking & Discovery: Creating mocking services, navigating the API Console, publishing to Anypoint Exchange, and configuring interactive API portals.

  • 2.2 Security & Version Management: Defining reusable security schemes (OAuth 2.0, Basic Auth), implementing Hypermedia (HATEOAS), and structuring non-breaking version management.

Logistical information

  •  Duration: 2 days (14 hours).

  • Registration Deadline: 5 working days before the training.

  • Teaching Methods: Alternation of theoretical and practical inputs, expert API trainer, course materials provided at the end of the training.

  • Assessment: Continuous and final assessment.