Creating a Google BigQuery API in Minutes with DreamFactory
Handwriting code for database APIs can be a time consuming and expensive process that often exposes organizations to a variety of risks relating to quality, consistency, and developer effort.
DreamFactory specializes in REST API generation for a range of databases that gives you the ability to generate a secure, fully documented API in minutes.
This article will highlight how easy it is to create an Google BigQuery on-premise API, demonstrating how you could save your organization considerable time, money and effort during the API development process.
Generating the Google BigQuery REST API
Step 1 – Select Your Database
To start building your Google BigQuery REST API, you’ll login to the DreamFactory administration interface, choose Connect to Database.
From there you’ll select the Google BigQuery service type by finding the Google BigQuery option or by searching for it in the search bar.
Step 2 – Configure Your API
Here you will be prompted to provide a name, label, and description. The latter two are used just for reference purposes within the administration interface, however the name value is particularly important because as you’ll soon see it will comprise part of the API URL.
Then, you’ll be prompted to provide the database connection credentials after pressing ‘next.’. Here you’ll provide JSON application credentials and Project ID.
Additionally, you can optionally specify advanced configuration options such as auth cache store, location, caching preferences, maximum records, and more
Step 3 – Choose your Security Access
Click on Security Config. Here you will be prompted to easily choose the type of access you want for this API service by just simply selecting each of the tiles and the type of read, write, or full access.
This can also be adjusted later within the Role Bases Access Control Interface, giving you additional fine grained access controls. Once complete, simply select Apply Security Configuration. THAT'S IT!
You have now in less than 2 mins created a new REST API against Google BigQuery that has automatically generated the database API, API Docs, RBAC, and the API Key that can be interrogated into your applications!
Step 4 – Test out Your Newly Secured API
DreamFactory automatically scanned your Google BigQuery database schema and generated full API Documentation end points for easy testing.
You can also test your API Key that was automatically generated for you when you set up your API right here in the DreamFactory Interface.
Simply click on Test API Authentication, choose the endpoints that you gave the database API access to during the security config and then select your API key from the Authentication method dropdown, and hit Test Auth.
These features ensure that APIs are easy to understand, use, and integrate, significantly reducing development time and enhancing collaboration across teams. The documentation is continuously updated to reflect any changes in the API, ensuring accuracy and reliability.