Apigee Project code base structure & automating process

[#1]

Hello,

Soon sometime I am going to start a Apigee project.

Any suggestion on how I should go about setting up project code base & handle all API life cycle pragmatically managed though automation process that all API are registered, deployed & endpoint tested.

I am thinking to go on with Grunt/Gulp scripting.

Your suggestions awaited & reference to existing process are most welcoming... 🙂

[#2 · Accepted solution]

Here are a few suggestions about the whole process:

Setup: if you are setting up the apigee private cloud, you can choose ansible, salt or any other scripting language to automate the setup process.

Codebase: You can use any version control system to manage your apigee codebase (Git, Gitlab, etc)

Deployment: You can use apigee maven-plugin to do the seem-less deployments, etc

Test: There are several open source test tools are available to automate the API testing (RestAssured, TestNG, Jmeter and many more), then plug them into CI to run continuously.

Thanks,

Archendra

[#3]

Hi @Basavaraja Dhanshetti , for Grunt.js you can leverage this one. https://community.apigee.com/articles/3935/api-proxy-generator.html. The sample code comes with Mocha and Chai for testing. Although you can use Newman from Postman too and integrate it as a task.

Hope it helps!

[dcouldwell]

Please take a look through the Apigee Accelerator Methodology pages https://community.apigee.com/accelerator-methodology for more hints and tips on getting started on setting up your API development program.

This includes notes on getting started with testing, monitoring, the developer portal and building APIs using Agile best practices.

[gaurav_bhandari]

@Basavaraja Dhanshetti

To add few more points, do maintain a sheet ie. consumer and Provider sheet which has complete details of the proxies like

API PROXY name,Consumer details, provide details, Northbound Cert Alias Name, API PRODUCT Name, Developer APP Name, VHOST, VIP, etc

Secondly, in case you are planning to use Message Logging policy, have a draft message ready that can be used for all the api proxies. This message should include all the basic APIGEE variables that can be used for debugging later

Thirdly, have design document template ready, naming convention document,etc

Also, have Code review document ready.

There are other important things as well, but these are the basic.