Arrow API Swagger Interface

When you create Arrow Builder APIs, the Arrow Admin Console displays your automatically-generated API docs in the API Docs tab as described here. An example is shown below:
Arrow API Swagger Interface
While the API Docs are appropriate for developers, what if you need to programmatically import the APIs into a tool such as the Axway API Manager? Arrow APIs also contain a Swagger definition that can be used this purpose.

Arrow Project Swagger

Your Arrow project Swagger file that describes all of the APIs in the project can be accessed at the following URL:
https://<SUB_DOMAIN_TOKEN>.cloudapp-enterprise-.appcelerator.com/arrow/swagger.json
For example, for my published Arrow Project, the Swagger definition can be found here:
https://cb0ed9de31943f6afc79b235afebae6553aeaf56.cloudapp-enterprise.appcelerator.com/arrow/swagger.json

Individual APIs

Each API also has a separate swagger definition associated with the API itself. This is convenient if you only need access to one API and not the entire set of APIs exposed by your Arrow Project.
For example, if you have a model and associated APIs for account as follows:

var Arrow = require('arrow');
var Model = Arrow.Model.reduce('appc.salesforce/Account', 'Account', {
    fields: {
        Name: {
            type: String,
            description: 'Account Name',
            maxlength: 255,
            required: true,
            optional: false
        },
        Type: {
            type: String,
            description: 'Account Type',
            maxlength: 40
        },
        Phone: {
            type: String,
            description: 'Account Phone',
            maxlength: 40
        }
    },
    actions: [
        'create',
        'read',
        'update',
        'delete',
        'deleteAll'
    ]
});
module.exports = Model;

API docs for this API can be found at the following URL:
https://.cloudapp-enterprise-.appcelerator.com/arrow/docs.html?apis/account.html
The swagger definition for account can be found at the following URL:
https://<SUB_DOMAIN_TOKEN>.cloudapp-enterprise-.appcelerator.com/arrow/docs.json?apis/account.json
Swagger files for the Arrow project and individual API’s can be found here.

Previous articleAxway Digital Forum with IDC in London
Next articleWant to gain digital momentum without losing control?
Principal Presales Architect II – Leor Brenman has over 12 years’ experience in Enterprise Software and more than 30 years working in the tech industry for companies like Vaultus, Antenna, Appcelerator and Axway. He has a strong technology background and specializes in mobile, API, integration and enterprise applications. Leor has a BS and MS in Electrical Engineering from Rutgers University in NJ, USA.

1 COMMENT

    • Thanks for the comment! Didn’t realize you had to scroll. You may need to scroll within the code block as well. Will see if we can fix that.

LEAVE A REPLY

Please enter your comment!
Please enter your name here