Photo by Domenico Loia on Unsplash

WSO2 API Manager is an Open Source Platform which anyone can contribute to. All community contributions are welcome.

WSO2 Developers carry out active development in the following repositories for WSO2 API Manager.

  1. carbon-apimgt (branch — master)
  2. product-apim (branch — master)
  • Java 1.8 or higher.
  • Maven 3.0.4 or higher.
  • Minimum memory 2GB.

How to quickly build a latest WSO2 API Manager pack (distribution) and start the server locally?

mvn clean install -Dmaven.test.skip=true
  • Obtain the WSO2 API Manager pack from <product-apim>/modules/distribution/product/target directory and extract it to your desired location.

Example package name :

  • Start the WSO2 API Manager server by moving into…

Is my product pack working fine in a real scenario?

Photo by Kevin Ku on Unsplash

Scenario tests are where we test an actual local deployment of the product. You can simply start a server in your local machine and run the scenario test cases from the repository and verify if a complete scenario or a use case works fine with that particular deployment.

Instead of writing a lot in this post, let me keep it short and simple. 🙂

→ Repository containing scenario tests : product-apim

→ Branches containing scenario tests :

As in the following image, there is a scenario test branch for each…

After my changes some Integration Tests are failing! How can I find where the problem is? — Is this you? Then this article is for you.

Photo by Safar Safarov on Unsplash

You might get the requirement to debug Integration tests in WSO2 API Manager code after writing a test yourself in product-apim repository or else if a change done by you to carbon-apimgt repository causes a build failure.

Let’s see how this can be done easily.

Step 1 : Build the product-apim repo without tests.

Build the WSO2 API Manager distribution as described in the section titled “How to quickly build a latest WSO2 API Manager pack (distribution) and start the server locally?”, in…

Some unit tests are failing after my changes! How can I debug the unit test I wrote to see if it is working fine? — Is this you? Then this article is for you.

Photo by Riku Lu on Unsplash

After writing a unit test, you almost always get the requirement to debug the test case that you wrote. Or else if you encounter a build failure due to a failing unit test, you need to always debug and find what went wrong.

In this article, I’m going to show you how.

In WSO2 API Manager for example, unit tests can be found in carbon-apimgt repository…

Faced an issue when using the product and want assistance or need to report the issue? Here is what you need to do.

Photo by Kelly Sikkema on Unsplash

When developing the product, you might come across various issues related to an existing bug or a problem you can’t understand. Don’t worry. There are channels that you can take assistance from or report the issue which you think is a bug in the product.

I found a Bug in the product! 😮

For WSO2 API Manager, if you find a bug in the product, you have to report it in the product-apim GitHub repository.

  1. Simply go here.
  2. Click on the New Issue button.
  3. Fill…

Do you want to easily apply changes to the React Portals then and there when you are doing UI changes? Then this article is for you.

Photo by Cookie the Pom on Unsplash

When you are doing UI changes to one of the following React Portals in WSO2 API Manager, it is tiering to rebuild the project for every minor change you do.

  1. Publisher Portal (Accessed through https://localhost:9443/publisher)
  2. Developer Portal (Accessed through https://localhost:9443/devportal)
  3. Admin Portal (Accessed through https://localhost:9443/admin)

So let me show you how this can be very easily done in only 3 steps. The trick is to create a symlink between the portal app and the…

Do you want to easily push changes to the running server without having to build the pack over again? Then this article is for you.

Photo by Goran Ivos on Unsplash

When you are actively building WSO2 Products, it will be a real hassle to do a simple java code change and rebuild the entire pack over again to see if the change you did actually works. Urgh it sucks! 😖

In this article I will show you how this can be easily overcome. It’s very simple.

I will take the code base of WSO2 API Manager for example here. Consider this file in the carbon-apimgt

Want to become a contributor for WSO2 API Manager docs? Then this article is for you.

Photo by Aaron Burden on Unsplash

I will keep this article as simple as possible so that you can dive in right away. Short and Sweet! 🙂

  • Link to the documentation
  • GitHub repository for docs
  • Active branch for next release documentation → master
  • Branches for previous releases → Named after the release version. For example, branch 3.2.0 is for the documentation of WSO2 API Manager version 3.2.0.
  • Technology used for writing → MkDocs

How to get started?

In this article I will be showing you how the datasources can be configured in WSO2 API Manager 3.x products because this approach is different than what we had in our 2.x family of products configuring the master-datasources.xml.

The main intention of this change was to allow the users to make changes in a single location reducing the hassle of having to deal with multiple configuration files. Therefore you need to edit only the deployment.toml file in <APIM_HOME>/repository/conf directory.


At the end I will be providing you with a Bonus Tip 😍 which will help you do any configuration…

Code formatting is something that is really important for making code easily navigable and readable. I will explain how you can add a code formatter to your IDE so that you can make sure your code always meet those criteria.

I will specifically be focussing on setting up a code formatter in IntelliJ Idea IDE which is one of the mostly used IDEs we have now. For demonstration purpose I will be adding the code formatter that is used in WSO2 code for code formatting.

You can access the code formatter used here, from this link to my GitHub gist…

Tharika Madurapperuma

Senior Software Engineer @ WSO2 | Toastmaster

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store