APIkit Overview
APIkit scaffolds Mule applications from AsyncAPI, gRPC, GraphQL, OData, RAML, OpenAPI Specification (OAS), and SOAP contracts, validates inbound traffic against those contracts, and can generate MUnit test suites. Each protocol has a dedicated module; routing dispatches requests to the flows that implement your resources. The same general workflow—specify, scaffold, implement, test—applies across modules, so skills transfer among SOAP, REST, GraphQL, and event-driven APIs.
Supported Web Service Types
-
APIkit for AsyncAPI supports AsyncAPI APIs.
-
APIkit for gRPC supports gRPC APIs.
-
APIkit for GraphQL supports GraphQL APIs.
-
APIkit for OData V2 and APIkit for OData V4 support OData APIs.
-
APIkit for REST supports RAML and OAS APIs.
-
APIkit for SOAP supports SOAP 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 run-time 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 run-time 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.