API Builder – Frequently asked questions

1. How does the API Builder work?

The API Builder is a PLSQL program consisting of 4 SQL files.

One file is responsible for starting the process and setting API parameters. Two of the files create temporary tables and a Master package to create the outputted code. And the fourth file creates the “spooled” output of the code into a file called “output_script.sql”.

2. What do I need to run the API Builder?

Obviously you need an Oracle database, preferably version 10g or above. However the code should work from Version 8. (although this is not tested or guaranteed)
The API Builder needs to be run from an Oracle tool which allows you to “spool” out to a physical file.
SQL*PLUS and TOAD have been tested with API Builder and work well. However, please note that Oracle’s SQL Developer DOES NOT spool and will not work with API Builder.

3. What version of Oracle is API Builder tested on?

Oracle 10g. We are mostly confident that API Builder should work from Version 8 since the code is fairly generic, but this is not guaranteed.

4. Do you have a walk-through demonstration of the software?

Yes, click here for a full example of the API Builder.

5. How can I download API builder?

API builder can be downloaded here.

6. Once I download API Builder will it work straight away with my Oracle architecture?

The default setup of API Builder has a number of assumptions which must be in place for it to work. For example, your sequences must have the suffix <table_name>”_SEQ” in relation to the table they are made for.
It should be noted that the API Builder is a highly customisable piece of software which may need to be modified to work with your own software architecture.
All I can say is that the sample table (CUSTOMER) and sequence (CUSTOMER_SEQ) provided will work with API Builder using default settings.

7. So what is possible with API Builder in terms of my Daily build architecture?

API Builder can potentially generate tens of thousands of lines of code and can become an important component of your daily build.
Our tests, while developing API Builder, included a database schema of 30 tables generating 30 API packages all with complete DML functionality built on a daily routine using ANT.
This level of code generation can potentially save companies 100’s of hours of development time.

8. What are the future plans for API Builder?

Future versions will include full exception handling (coming soon!), more efficient handling of rowtypes and, most importantly, the inclusion of Unit Test packages for every API generated!

Watch this space or subscribe to our Newsletter.