Contact Us 1-800-596-4880
  1. Homepage

  2. APIkit (4.x)

APIkit Overview

APIkit is a toolkit that simplifies the development of API-led applications for Mule developers. It scaffolds applications from a given specification, validates input parameters, and creates MUnit test suites. APIkit has a module for each supported web-service type:

With APIkit, incoming requests are intelligently routed to the appropriate endpoints based on the defined API contracts. This routing mechanism simplifies request handling, improves performance, and ensures that requests are processed by the correct API resources.

Although each module works with a family of web services, all modules share common usage patterns. So if you’re a Mule developer who works with SOAP APIs, you can work with GraphQL, RAML, OData, or OAS APIs.

Features

  • APIkit generates the structure of a Mule application based on a supported API specification.

  • APIkit includes sources and operations that perform complex input validations according to the requirements in the API specification.

  • The APIkit for REST module includes an API console that enables you to experiment with the API project as you develop it.

  • Some APIkit modules include extensions for Anypoint Studio and Anypoint Code Builder for enhancing your editing experience in the supported development environments.

Before You Begin Using APIkit

You must have access to Anypoint Studio or Anypoint Code Builder to scaffold a supported API specification with APIkit.

APIkit Versions

APIkit works as a module with Mule runtime version 4. Documentation for the Mule 3 implementation of APIkit is available here. If you use APIkit on Mule 3, the module version matches the runtime version.

By default, Studio includes the APIkit for REST and APIkit for SOAP modules. If you need the GraphQL or OData modules, follow the installation instructions in each section.

See Also