Apigee Tools & Plugins - Apigee Development Made Easy

Google Cloud Apigee Knowledge Hub
1

Hello Everyone,

Apigee Teams & Apigeeks built many tools that will be helpful to quickly build API Programs & help Api Developers while working with Apigee Edge & Other Apigee Products. In this article, let’s take a look at various tools, plugins, scripts, command line tools that will help Apigee Developer which makes life easy.

  1. ApiStudio.io:
  • Use openApi to design your APIs
  • Share API Spec with your team
  • Test your APIs

2. Apigee-127 :

  • Model First toolkit to build enterprise class APIs
  • Open Source
  • Built on Node.js
  1. Apigee Tool :
  • Command line tool for deploying API proxies and Node.js applications to the Apigee Edge platform. The tool also lets you list and undeploy API proxies.
  • Built on Node.js
  • You can do below operations from your machine.
  • Supports Deploying an API proxy to Edge.
  • Undeploying an API proxy from Edge.
  • Deploying Node.js apps to Edge.
  • Listing deployed API proxies on Edge. Access API Proxies on your local machine instead of Management UI.
  • Retrieving deployed proxies and apps from Edge.
  • Deleting proxy definitions from Edge.
  • Retrieving log messages from Node.js apps deployed to Edge.
  1. Apigee Maven Plugin :
  • apigee-edge-maven-plugin is a build and deploy utility for building and deploying the Apigee ApiProxy’s/Application bundles into Apigee Edge Platform.
  • The Maven build strategy is a good strategy if your current enterprise build and deploy strategies already use Maven or Maven compatible tools.
  1. Apigee Grunt Plugin :
  • Tool to manage the API Development Lifecycle for Apigee
  • Pluggable environment (thousands of npm and grunt modules and plugins).
  • Grunt is perfect for applying continuous improvement by easily adding custom tasks.
  1. Sweetlime :
  • SweetLime is Sublime Text 3 plugin to develop Apigee Proxies. With built in template support for policies, steps and flows, SweetLime helps proxy developers build proxies with ease.
  • Proxies developed with SweetLime can be deployed to either the Apigee cloud or your on-prem apigee edge installation (OPDK customers).
  • Great tool to quickly build API Proxies in Apigee Edge by coding instead of configuring.
  • Developers love this tool where they can code instead of configuration in Apigee UI
  1. OpenAPI2Apigee : (Earlier called swagger2api)
  • Command line tool that converts OpenAPI ( swagger ) spec 2.0 file to Apigee API Proxy Bundle.
  • Built on Node.js
  • Quickly build API Proxies & Flows using OpenAPI spec.
  • Deploy API Proxies generated from OpenAPI Spec to Apigee Edge.
  1. Apigee2openapi : (Earlier called Apigee2Swagger)
  • Command line tool that converts Apigee API Proxy Bundle to OpenAPI spec 2.0 file .
  • Built on Node.js
  • It will help to generate OpenAPI 2.0 spec for Apigee Developer Portal Smartdocs.
  • Find more detailed article here on using same.
  1. Swagger-Utility:
  • Swagger utility is a Java utility for generating API proxies from Swagger API Model. So it is Swagger API Model to API Proxies genrator tool.
  • Similar to Swagger2Api but built on Java
  • Supports Apigee-127 generated swagger files.
  1. Apigee Javascript Debugger :
  • A library providing utility methods to support the execution and debugging of Apigee Edge JSC callout policies on your local machine.
  • This library requires no additional code in your javascript, and it executes outside the core framework of Edge.
  1. Apickli :
  • Apickli is a REST API integration testing framework based on cucumber.js.
  • It provides a gherkin framework and a collection of utility functions to make API testing easy and less time consuming. Apickli is also available as an NPM package.
  • Cucumber.js is JavaScript & Node.js implementation of Behaviour Driven Development test framework - Cucumber.
  • Cucumber.js is using Gherkin language for describing the test scenarios in BDD manner.
  1. Apigee Edge Node SDK :
  • Node.JS SDK for Apigee Management API
  • Easily integrate Apigee Management APIs into your existing Node.JS Applications.
  • For Example, If you want to build Apigee Developer Portal using Node.JS framework it will be extremely useful.
  1. API Platform Tools - Python :
  • Similar to Apigee Tool, But python based. Project contains tools for the Apigee Gateway Services platform.
  • Deploy API proxies
  • Create skeleton proxies
  • Deploy Node.js applications
  1. Edge-PHP-SDK :
  • PHP SDK for Apigee Edge Management API.
  • Apigee Developer Portal uses this SDK to communicate with Apigee Edge.
  • Helpful for Integrating Apigee Edge with PHP based applications.
  1. ApigeeDM - Apigee Deploy Multiple Proxies :
  • Deploy multiple Apigee API Proxies at one go using command line
  • Built on top of ApigeeNodeTool
  • Support for integrating into other scripts
  1. API2Swagger :
  • Swagger 2.0 Specification Generator
  • CURL Like command syntax
  • Support JSON/Plain text request/response
  • Support for GET / POST / PUT / DELETE http method
  • Saves lot of time, changes the way you write API documentation / display same using smartdocs / swagger UI
  • Runs on local machine, built on top of Node.JS
  • Find more about same here
  1. OpenAPI Specification Generator :
  • Generate Open API Spec: Easy step-by-step process
  • Share Open API Spec with Team
  • Collaborate on the cloud

Cheers,

Anil Sagar

12 Likes
2

Very useful, thanks Anil.

One additional tool that we have found very useful is the Apigee JSC Debug Framework for locally debugging javascript (GitHub - apigeecs/apigee-jsc-debug: Tooling to support offline debug, performance monitoring, and replay of trace sessions.) Thanks to @David Allen for this one.

Additionally for Behaviour Driven Development, apickli is built on top of cucumber.js providing a number of predefined step definitions for rapid development of a test suite. (GitHub - apickli/apickli: apickli - REST API integration testing framework based on cucumber.js) Thanks to @Ozan Seymen and @Saul Zukauskas for this!

3

Thank you @Sean Davis , Updated them to the list. Feel free to edit article next time if you come across any other Apigee Plugins :slight_smile:

4

Hi @Sean Davis From what I understand the trace files are “required” to execute the javascript callouts locally. Can https://github.com/apigeecs/apigee-jsc-debug/blob/master/sampleProxy/24Solver/tests/debug/tests.js be run without trace file?

5

Hello, I am using Apigee-127. How can I add APIgee proxies and deploy, is there anyway to add all the policies of APIgee if required ?

I see in the Apigee-127 documentation

https://github.com/apigee-127/a127-documentation/wiki/Policies

List of available policies

Thanks,

Ravi

6

hi @ravikanth.nawada - can you post a new question please ?

7

@Sai Saran Vaidyanathan Sorry I did not get you, I read this post already and raised a question by rephrasing it. Below is the link.

https://community.apigee.com/questions/48472/apigee-127-how-can-i-add-apigee-proxies-and-deploy.html

8

thanks.. just wanted to be sure that we have this question raised separately. did not want to sideline this post which was mainly for information

9

apigeelint

Static code analysis for Apigee proxy bundles to encourage API developers to use best practices and avoid anti-patterns.

https://www.npmjs.com/package/apigeelint

10

@Anil Sagar If you can add listed if applicable

I think when it comes to migration this tool can help in some aspects, not sure if you want to list here only for development related and Migration you wanted to list them seperate..

https://github.com/apigeecs/apigee-migrate-tool

and other tool which i found useful during development

https://github.com/apigeecs/ApigeeBundleReaper

11

Hello @Anil Sagar @ Google

Could you also add the SonarQube plugin for Apigee in this list, please ?

Here is the dedicated page :

https://community.apigee.com/articles/49758/apigee-sonarqube-plugin.html

You can pick up some bullet points from there.

Thanks.