apim-apps

WSO2 API Manager Portals

A comprehensive web application suite for WSO2 API Manager, providing intuitive interfaces for API management, development, and administration.

Branch / Status	Azure	Jenkins
master

Overview

The WSO2 API Manager Apps consist of several modular web applications designed to provide comprehensive API management capabilities:

API Publisher Portal - Create, design, implement, and manage APIs
API Developer Portal - Discover, explore, and consume APIs
API Admin Portal - Administrative functions and portal management
Integration Tests - Test suites for all portals

Prerequisites

Node.js - Install version 22.x or later LTS from nodejs.org
- Alternatively, use nvm to manage Node.js versions

Optional Dependencies

The following dependencies are only required if you plan to build the complete WSO2 API Manager distribution:

Apache Maven - Download from maven.apache.org
JDK 1.8 - Download from Oracle or use OpenJDK

Quick Start

Development Workflow

When developing and fixing issues in specific web applications, you don’t need to build the entire repository. Here’s how to work on a specific portal (using the Publisher as an example):

Step 1: Set Up WSO2 API Manager Server

Option A: Download the pre-built distribution from wso2.com/api-manager
Option B: Build the server yourself by following the product-apim guide

Step 2: Start the API Manager Server

# Navigate to the server's bin directory
cd path/to/wso2am-4.x.x/bin

# Start the server (Unix/Linux/macOS)
./api-manager.sh
# Or for Windows
api-manager.bat

Step 3: Clone the apim-apps Repository

git clone https://github.com/wso2/apim-apps
cd apim-apps

Step 4: Set Up the Portal for Development

# Navigate to the specific portal directory
cd portals/publisher/src/main/webapp
npm ci

Step 5: Start the Development Server

# From the src/main/webapp directory
npm start

The development server will start with hot-reload capabilities, allowing you to see changes immediately. The development servers will run on the following default ports:

Publisher Portal: http://localhost:8081/publisher
Developer Portal: http://localhost:8084/devportal
Admin Portal: http://localhost:8083/admin

Default Credentials: Use admin / admin for username and password to log into all portals.

Step 6: Validate Changes

Before committing your changes:

# Run production build to check for errors
npm run build:prod

Note: You can use mvn clean install at the root level to build all 3 portals, or navigate to a specific portal’s directory and run it there to build only that component. If you use this method, you will need to copy the built .war files manually to the <API-M_HOME>/repository/deployment/server/webapps directory.

Testing

Integration Tests

The project uses the Cypress Testing Framework for comprehensive end-to-end testing.

Setup

cd tests
npm install

Test Execution Modes

Headless Mode (CI/CD)

Execute tests in the command line without a GUI - ideal for continuous integration:

npm run test

Headed Mode (Visual Debugging)

Run tests with a visible browser interface for debugging:

npm run test:gui

Interactive Mode (Development)

Open the Cypress Test Runner for selective test execution and debugging:

npm run test:dev

Support

WSO2 LLC. offers a variety of development and production support programs, ranging from Web-based support up through normal business hours, to premium 24x7 phone support.

For additional support information please refer to http://wso2.com/support

For more information on WSO2 API Manager please visit https://wso2.com/api-management/

Known Issues of WSO2 API Manager

All known issues of WSO2 API Manager are filed at:

https://github.com/wso2/api-manager/issues

This site is open source. Improve this page.