wso2 / wso2/api-platform

[Task]: Support extending Platform API via a Plugin Development Kit (PDK)

Open
#2,831 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Aspect/API Type/Task
Dominant language
Go
Stars
71
Forks
111
Avg merge
1d 14h
Merged PRs (30d)
110

Description

Please select the area the issue is related to

Platform API

Please select the aspect the issue is related to

Aspect/API (API backends, definitions, contracts, interfaces, OpenAPI)

Description

Problem

platform-api can only be extended by editing it. A separate module cannot add its own REST APIs, config, or middleware without forking or patching platform-api sources.

Requirement

Make platform-api an importable library with a public, stable extension contract (a Plugin Development Kit), so a wrapper module can run and extend the full platform server by importing it — without changing platform-api.

At a high level:

  • A wrapper can run the platform server and register its own plugins.
  • A plugin can add REST APIs, an OpenAPI spec, and request-chain middleware.
  • Plugins reach the platform through a public capability contract, never internal packages.
  • Extension routes run under the platform's existing auth and scope enforcement.
  • Extension is compile-time (by import); no runtime plugin loading.
  • The default build behaves exactly as before.

Related:
N/A

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by locating the platform-api server entry point and its existing API, OpenAPI, authentication, scope-enforcement, and middleware boundaries. Done means a wrapper can import and run the server, plugins can register APIs, an OpenAPI spec, and middleware through a public contract, and the default build remains unchanged.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.