📢 Attention Salesforce Certified Trailblazers! Maintain your credentials and link your Trailhead and Webassessor accounts by April 19th. Learn more.
close

Get Started with Anypoint Design Center

In this quick start, you learn about API specifications and how MuleSoft Anypoint Platform uses them to begin building data integrations. This includes some time-saving tips to help get your integrations up and running quickly!

Why Design an API Spec First

The best way to get started with your integration is to write an API specification. API specifications explain API behaviors, fundamental design philosophy, and supported data types. Taking the time upfront can pay off big time later down the line.

  • It serves as documentation for reuse by future applications via the Anypoint Exchange.
  • Stakeholders/consumers of the APIs can perform acceptance tests before the app is ever built.
  • It can be used to prepopulate your implementation with artifacts and metadata to reduce development time.

Get Set Up

Sign up for a free 30-day Anypoint Platform account if you haven’t done so yet. It’s free!

So, What Is an API Specification?

An API specification is a contract that is easily digestible by both humans and computer systems. It’s digestible because it combines both API documentation (think READMEs) and API definitions (like WSDL files). This design simplifies understanding of how to interact with the implementation, which increases adoption and speeds up project completion. So let’s start thinking about our API specification in the language you use: RESTful API Modeling Language (RAML). 

Note

Note

RAML is the native API specification language in MuleSoft's API Designer, though OAS/Swagger import is also supported and converted to RAML. For more information on RAML, please visit RAML.org.

The Ecommerce Example

For this quick start, let’s assume we’re building APIs for an ecommerce store—you can begin by building a product API. One of the requirements for a product API is to provide details about a specific item in the store. You can create a /products/{productId} endpoint that supports a HTTP GET method and provide details on what to request and how to respond.

We won’t check any of your setup. Click Verify Step to go to the next step in the project.

retargeting