Axway API-Manager CLI API Import-Tool

Exports existing APIs from a running API-Manager to get the required API-Import assets.

License

License

Categories

Categories

CLI User Interface
GroupId

GroupId

com.github.axway-api-management-plus.apim-cli
ArtifactId

ArtifactId

apimcli-api-import
Last Version

Last Version

1.1.0
Release Date

Release Date

Type

Type

jar
Description

Description

Axway API-Manager CLI API Import-Tool
Exports existing APIs from a running API-Manager to get the required API-Import assets.
Project URL

Project URL

https://github.com/Axway-API-Management-Plus/apim-cli

Download apimcli-api-import

How to add to project

<!-- https://jarcasting.com/artifacts/com.github.axway-api-management-plus.apim-cli/apimcli-api-import/ -->
<dependency>
    <groupId>com.github.axway-api-management-plus.apim-cli</groupId>
    <artifactId>apimcli-api-import</artifactId>
    <version>1.1.0</version>
</dependency>
// https://jarcasting.com/artifacts/com.github.axway-api-management-plus.apim-cli/apimcli-api-import/
implementation 'com.github.axway-api-management-plus.apim-cli:apimcli-api-import:1.1.0'
// https://jarcasting.com/artifacts/com.github.axway-api-management-plus.apim-cli/apimcli-api-import/
implementation ("com.github.axway-api-management-plus.apim-cli:apimcli-api-import:1.1.0")
'com.github.axway-api-management-plus.apim-cli:apimcli-api-import:jar:1.1.0'
<dependency org="com.github.axway-api-management-plus.apim-cli" name="apimcli-api-import" rev="1.1.0">
  <artifact name="apimcli-api-import" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.github.axway-api-management-plus.apim-cli', module='apimcli-api-import', version='1.1.0')
)
libraryDependencies += "com.github.axway-api-management-plus.apim-cli" % "apimcli-api-import" % "1.1.0"
[com.github.axway-api-management-plus.apim-cli/apimcli-api-import "1.1.0"]

Dependencies

compile (11)

Group / Artifact Type Version
com.github.axway-api-management-plus.apim-cli : apimcli-apim-adapter jar 1.1.0
com.github.axway-api-management-plus.apim-cli : apimcli-tool jar 1.1.0
org.apache.httpcomponents : httpclient jar 4.5.6
commons-cli : commons-cli jar 1.4
commons-io : commons-io jar 2.6
commons-lang : commons-lang jar 2.6
org.apache.commons : commons-text jar 1.7
org.apache.httpcomponents : httpmime jar 4.5.6
com.fasterxml.jackson.core : jackson-core jar 2.9.10
com.fasterxml.jackson.core : jackson-databind jar 2.9.10.5
org.slf4j : slf4j-log4j12 jar 1.7.25

test (7)

Group / Artifact Type Version
com.github.axway-api-management-plus.apim-cli : apimcli-apim-adapter test-jar 1.1.0
com.consol.citrus : citrus-core jar 2.7.7
com.consol.citrus : citrus-jms jar 2.7.7
com.consol.citrus : citrus-ws jar 2.7.7
com.consol.citrus : citrus-http jar 2.7.7
com.consol.citrus : citrus-java-dsl jar 2.7.7
org.testng : testng jar 6.9.10

Project Modules

There are no modules declared in this project.

Axway API-Management CLI

This CLI allows you to control the Axway API management solution without access through the Web UI. You can call the CLI manually or integrate it into a CI/CD pipeline. The CLI is based on Swagger-Promote, which has been refactored to support more use-cases than only API-Import and -Export.

Everything as code

The basic idea for the so-called "Everything as code" approach is that the desired state of something (API, Application, etc.) is declared in a configuration file which stored in your version management system. A tool, like this CLI, is then replicating that declared state to become the actual state in the target environment. This is used for instance to manage complex Cloud-Infrastructure called Infrastructure as code. You may read more here: https://hackernoon.com/everything-as-code-explained-0ibg32a3

This CLI is following the same approach for your APIs, Applications, etc. Everything is declared as code in a config file and stored in your version management system. The CLI transfers this desired state manually or automatically via a pipeline into the API management platform to become the actual state.
Additionally the CLI supports basic administrative commands for instance to list and filter entities and perform simple tasks. More will be added very soon.

Watch this video (28 min): https://youtu.be/2i8i1zMAMps to get an overview + demo.

With that, an API developer or the operations team is just providing the desired state configuration of the API, Application. When checked in, the CI/CD-Pipeline picks it up and replicates it into the API Manager.

API Manager CLI overview

Supported commands

The CLI is flexible and is extended with new functions via modules. These can be accessed and discovered via the CLI on the basis of groups and their commands.
To get an overview about the groups just call apim:

Available commands and options:
apim app             Manage your applications 
apim org             Manage your organizations
apim api             Manage your APIs 
apim user            Manage your users 

To get for instance a wide list of APIs on the stage: prod execute the following command:

apim api get -s prod -wide
....
+--------------------------------------+-----------------+----------------+---------+---------------------+-------------+-------------+----------+----------------------+
| API-Id                               | Path            | Name           | Version | V-Host              | State       | Security    | Policies | Organization         |
+--------------------------------------+-----------------+----------------+---------+---------------------+-------------+-------------+----------+----------------------+
| 518b15c9-350c-47d8-9ad6-16ce02ef9dfe | /vhost-test-950 | VHost Test 950 |   1.0.0 | api123.customer.com | unpublished | passThrough | None     | API Development 5538 |
| 39b7b2aa-7df8-44e0-b399-4e9d59dbad6d | /vhost-test-411 | VHost Test 411 |   1.0.0 | api123.customer.com |   published | passThrough | None     | API Development 5916 |
+--------------------------------------+-----------------+----------------+---------+---------------------+-------------+-------------+----------+----------------------+
......

To get a list of commands for each group call for instance apim app

The CLI is flexible and more commands will be added. For an up-to-date list of the supported groups and commands, see the documentation.

Quality assurance process

By using this CLI to control your Axway API management infrastructure it becomes a key component of your CI/CD process. Product quality is therefore very important so that you can be confident this CLI is doing what it's supposed to do.
To achieve this quality bar, the tools was developed from the beginning in a way that it can be tested fully automatically.
In addition to a number of executed unit-tests, sophisticated integration tests are performed. These integration tests are executed against different API-Management versions and consists of a number of different scenarios. Each scenrioa contains various Desired states, which are transferred into Actual state by the CLI and finally checked if the Actual State in the API-Manager is as expected. This is performed for APIs and applications.

The automated End-2-End test suite contains of 116 different scenarios, which includes more than 284 executions of CLI (Import & Export) following each by a validation step. The test suite is executed at Travis CI for the following versions and you may check yourself what is done by clicking on the badge icon:

Version Branch Status Comment
7.6.2 SP5 develop Build Status
7.7.0 SP2 test-with-7.7-SP2 Build Status
7.7-20200130 test-with-7.7-20200130 Build Status
7.7-20200331 test-with-7.7-20200331 Build Status
7.7-20200530 test-with-7.7-20200530 Build Status
7.7-20200730 test-with-7.7-20200730 Build Status
7.7-20200930 test-with-7.7-20200930 Build Status Multi-Org is not yet supported

Version 7.5.3 is NOT supported. Version 7.6.2 SP3 is required.

Get started

To get started, you have several options to download the CLI and then just run the CLI as shown in the example below

scripts\apim api import -c samples/basic/minimal-config-api-definition.json -s api-env

This command is reading the API-Management platform configuration details from the environment file: env.api-env.properties and replicates the given desired API state in the configuration file: minimal-config-api-definition.json into the API-Management platform.

Please see the documentation for more information.

Changelog

See change log

Contributing

Contributions welcome

Please read Contributing.md for details on our code of conduct, and the process for submitting pull requests to us.
Also please read this page on how to contribute to this project.

Team

alt text Axway Team

License

Apache License 2.0

com.github.axway-api-management-plus.apim-cli

Axway API Management Plus

Axway API Management Plus artifacts

Versions

Version
1.1.0
1.0.1
1.0.0
1.0.0-RC1