Axway API-Builder is a very flexible low-code no-code framework that helps customers to create or optimize APIs for an API-Management governance layer by:

• orchestrating system of record APIs into a business oriented API
  • connect to different Cloud- or On-Premise applications
  • connect to databases to create CRUD APIs in minutes
• transform / mediate downstream APIs

Watch this video to learn more about API-Builder or just get started.

The underlying framework of API-Builder is Node.js using a bunch of NPM packages.
This repository is used to maintain community packages following the process described below.
There are some benefits why it makes sense to share your plugin:

• Axway takes care about this repository to test, release and publish your package
• upon Axway decision the plugin gets integrated into the API-Builder Plugin UI for simple installation and discovery
• Broader community and Axway support will help to improve your plugin
• Quality-Gate for changes on existing plugins
• Axway helps on a best-effort basis to support the community plugins

Once a plugin package has been approved by the Axway API-Builder core team it will appear for installation in the API-Builder Admin UI:

Please note that API-Builder Plugins in this repository are maintained by the community. The current maintainer is listed in package.json and will address the pull requests and issues opened for that API-Builder plugin. Additionally, Axway will assist on a best-effort basis, and will support the current maintainer whenever possible. When submitting a new plugin, please indicate in the Pull-Request that you're willing to become the maintainer. For current maintainers, we understand circumstances change. If you're no longer able to maintain a plugin, please notify us so we can find a new maintainer or mark the plugin as orphaned. If you have any questions about the process, don't hesitate to contact us.

API-Builder supports different kind of plugins. Learn more in the Axway documentation.
To share a plugin you have created with the community and make it available in the API-Builder UI, please follow this process:

1. Implement the plugin locally as described below and in the Axway documentation.

• you can build and test the plugin locally at all time

2. Create a fork of the api-builder-extras repository
3. Within that fork create a unique folder for your plugin using this naming convention:

• Flow-Nodes: api-builder-plugin-fn-
• Flow-Node connectors: api-builder-plugin-fc-
• Data-Connectors: api-builder-plugin-dc-

4. Insert your new plugin into that folder
5. Update the package.json

• Especially the fields: name, version, repository, homepage, bugs

6. Create your unique GitHub actions based on the template .github/workflows/_template*

• you need to adjust the ID after you have copied the template

Once you have completed the development of your new API-Builder plugin, submit a pull request to have Axway review your code. Once we've reviewed your plugin, we will approve and merge your pull request or provide feedback. When approved and merged we will release an NPM package. From this point on the plugin can be installed in API-Builder using npm install.

The Axway API-Builder core team will finally decide if that package becomes part of the Plugin-List as part of the next release. This allows also other API-Builder users to quickly discover and manage you plugin.

A flow node can be used as part of an API-Builder flow to process any kind of data available in the flow context. For instance create an MD5 Hashsum based on a header variable, etc.
Use the Flow-Node SDK to create a new flow node.

The actual flow-node connectors are based on the Swagger-Flow-Node, that allow you to create a Connector based on a Swagger-Definition. Learn more in the documentation and just review existing Flow-Connectors.

A Data-Connector is the most sophisticated plugin. Please check existing Data-Connectors or create an issue for help.

To report issues or get help, please create an issue here on GitHub.