Home
Introduction
Swagger/OpenAPI specification are the best for design, document and managing Restful API’s. MuleSoft recently joined the OpenAPI Initiative of the Linux Foundation, and now MuleSoft’s Anypoint Platform explicitly supports Swagger/OAS for describing APIs. MuleSoft Design Center supports importing an OAS 3.0 specification in JSON or ZIP format from the file system. We can also import an OAS 3.0 specification from the internet.
In this article, we will demonstrate how we can use OAS 3.0 API Specification in MuleSoft for API design, implementations and managing.
Overview
We can design, implement, deploy, and operate APIs using native OpenAPI Specification (OAS) 3.0 formats in Anypoint Platform. Support for OAS 3.0 is included in API Designer, Anypoint Studio, Anypoint Exchange, API Manager, and Anypoint API Community Manager.
We can catalog existing OAS 3.0 API specifications to share with partners, customers, and developers in the platform or in internal and external API communities. We can also manage and secure your OAS 3.0 APIs by applying appropriate policies.
I will be showing in this tutorial how we can design OpenAPI specification in Anypoint Platform, publishing to exchange and managing API in API Manager.
API lifecycle stages in Anypoint Platform
OAS 3.0 is supported by all the products in Anypoint Platform for the API lifecycle stages of design, publish, and manage.
|
There are many ways we can create/convert OAS in Anypoint platform using design center. Let me explain the how we can create new OAS in design center.
1. creating a new API-specification project, select OAS 3.0 in the Language field.
2. Edit the OAS 3.0 contact based on your API requirements. We can create specification in JSON, YAML format. I have created contacts API specification in design center.
3. Or we can import existing OAS 3.0 specifications from Anypoint Exchange or from your filesystem
4. Click the gear icon in the top-right corner of the text editor.
5. Select either of these options:
a. Select Import from Exchange to see both of these lists:
i. A list of the API specifications that are available from the business organization that your user ID belongs to in Anypoint Platform.
ii. A list of the API specifications that are published by MuleSoft
b. Select Import to import an API specification from your local filesystem.
6. Develop and edit OAS 3.0 specifications.
7. View documentation that is included in OAS 3.0 API specifications.
8. Simulate calls to methods that are in OAS 3.0 API specifications by activating the mocking service.
Publish in Anypoint Exchange:
Whatever we created in design center we can publish to Anypoint Exchange. Click on Publish button on right corner of the project in Anypoint Design center.
Select the version and click on Publish to Exchange.
Now we can go to exchange and see the API Design document.
Implement in Anypoint Studio:
Now are going to implement the API using the OAS design document in Anypoint Studio.
1. Create Mule Project in Anypoint Studio. Enter the project name and import a published API by searching the API which we published in exchange in above step.
2. Once we click on Finish, we should able to see the flows which are generated. We should do our business logic on top of it.
Deploy the and test:
In the above steps we implemented a Mulesoft API which generated basic flows using OAS design document. Now we can deploy the application in runtime manager and we can test it.
Right click on project in Anypoint Studio and select Run as Mulesoft Application. It will deploy in Mulesoft runtime. As this application have GET, POST methods with contacts resource name we can test using API console. Once deployed the application, we can open the API console using below url.
http://localhost:8081/console/
You can select GET method and click on Send button. We should able to see 200 status code with response.
You can remove the firstName from request and click on Send in POST method. It will return 400 status code with Bad Request message.
Manage API in Anypoint API Manager:
We can create OAS 3.0 APIs as the following types in API Manager:
o Basic Endpoint for Mule applications (callbacks not supported)
o Basic Endpoint for non-Mule applications
o Endpoint with proxy (callbacks not supported)
We can manage your OAS 3.0 APIs by creating versions and instances and applying policies from API Manager.
1. In API Manager click on Manage API and select Manage API from Exchange. Search for API Name and select appropriate api.
2. All the values will be populated automatically. Select Mule version and click on Save.
We can apply the policies on top of it and we can manage this API as per our requirements.
Conclusion
To explicitly bridge RAML and OAS approaches, MuleSoft has built an open source API Modeling Framework (AMF), available now under the Apache License, which reads and writes both RAML and OAS. In so doing, we are explicitly committing to interoperability between RAML as a modeling language and OAS as a description language. As a developer, you can design and model your API in either format, but RAML offers many more capabilities for modeling, reusability, consistency, modularity, and separation of concerns — that is its design goal, after all. Developers can describe their API in either format, but OAS enjoys broader adoption across a wider spectrum of tools and vendors. With AMF, you can choose either format depending on which design goals are important for you, and benefit from a common document model (DOM), a common service model, and a common domain model for programmatically interacting with the API specification in either format.
Download
|
S. No |
File Name |
Size |
Download |
|
1 |
OpenAPI Specification 3.0 in Mulesoft.pdf |
650 KB |
Comments
Post a Comment