Mastering Mulesoft Anypoint Platform

Designing your first API

• API Specifications using API Designer
• How to use API specifications to begin a Data Integration
• Time-saving considerations while designing API Specifications
• Test/Validate API specification in API Console

API Specification

It is a contract which can be consumed by humans and machines. Has README and API Definitions (e.g. WSDL) files. RAML (RESTful API Modeling Language) is API specification language for API Designer

• Serves as documentation for the consumption of the API
• Reuse of deployed API by future apps via Exchange
• The consumers of the APIs can perform acceptance tests before the app is ever built
• Can be used to pre-populate your implementation with artifacts and metadata to reduce development time

Simple API Design Example

• Create a resource (fm)
• Add a queryParameter (zip)
• Test the mocking service (/fm/03060)

TODO

• Sign up for a 30-day Anypoint Platform account by clicking here Sign up

• Login

• API Designer will be used for creating API Specification

• Mule Apps will be created in Flow Designer
• Download Product-Database from here
  • It has 3 tabs
    • Category
    • Product
    • Variant

Let us create an eCommerce API

• Product API
  • provide details about a specific item in the store /products/{productId}

Design Center

• Cloud based development environment for building Mule Apps and API specs

References

• Design your first API
• RAML 100 Tutorial