This repository was archived by the owner on Aug 11, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 21
8. API Manager Report tool
Chris Wiechmann edited this page Aug 8, 2019
·
6 revisions
A project that has started to automate APIs based on Swagger is now becoming more and more an API manager CLI.
The API-Manager report tool is using Swagger-Promote-Core as a library for the API-Manager communication and can downloaded from this separate repository: https://github.com/Axway-API-Management-Plus/apimanager-report-tool
With that you can export information from your API-Manager into different reports (right now two, but expecting more to come).
There is a dedicated script delivered with the release called: run-metadata-export.sh
, which generates the following usage:
usage: API-Manager Meta-Data Export -f <api-mgr-prod-metadata-export.csv> [-h <api-host>] [-p <changeme>] [-port <8181>] -r
<CSVEmbeddedAnalyticsReport> [-u <apiadmin>]
-f,--filename <api-mgr-prod-metadata-export.csv> Filename used to export meta-data configuration (relative or absolute).
-h,--host <api-host> The API-Manager hostname the API should be imported
-p,--password <changeme> Password used to authenticate
-port <8181> Optional parameter to declare the API-Manager port. Defaults to 8075.
-r,--report <CSVEmbeddedAnalyticsReport> Type of report you want.
-u,--username <apiadmin> Username used to authenticate. Please note, that this user must have Admin-Role
Tool to query your API-Manager registry and generate reports in some formats.
Originally invented to feed API-Metadata into Axway EA4APIM. Flexible for other formats
The following Report-Formats are supported:
CSVEmbeddedAnalyticsReport:
Generates a report with APIs, Applications, Orgs and their relation to each other. (CSV-Format)
CSVCustomPolicyDependencyReport:
Tells you which APIs are using which Custom-Policies (CSV-Format)
ExcelCustomPolicyDependencyReport:
Tells you which APIs are using which Custom-Policies (Excel-Format)
ERROR: Missing required option: r
You may run one of the following examples:
scripts\run-metadata-export.bat -h localhost -u apiadmin -p changeme -f custom-policies -r ExcelCustomPolicyDependencyReport
For more information visit: https://github.com/Axway-API-Management-Plus/apimanager-swagger-promote/wiki
This is an example report about used Custom-Policies:
☝️ Swagger-Promote has been discontinued and is replaced by the new APIM-CLI