Build beautiful and interactive API documentation for ORDS

Image
In this blog post, I will show you how to quickly build beautiful and interactive API documentation for your Oracle APEX REST data sources using  swagger hub . Using APEX v23.1. I downloaded the  titanic data set  and loaded them into tables in my APEX instance, created some authorized restful services and published them using swagger hub. You can create a free account on swagger hub.   Check out my titanic swagger hub here ; Press Authorize. Username REST, password Glasgow123! I won't go through creating RESTful services and just show you the four I created that sit on top of the titanic data set; The GET is a very simple SQL query;      select * from TITANIC_DATA_SET_NEW A handy tip is to add comments, as there will appear on swagger hub, making your API self documenting; Once you have created your modules, press the Generate Swagger Doc button; This will generate an open API for you.  Copy the API and paste it into swagger hub This will generate the documentation; As mentioned b
Post a Comment

Test & Monitor you APEX app. Part 1 : Monitor your APEX app using Jenkins

This is the first of a series of posts where I will show you how you can use Jenkins, Selenium, JMeter and Maven to test, monitor and create a continuous integration pipeline for your APEX application.

This is part 1, Set-up Jenkins to monitor your APEX app and get alerted when your app is unavailable.

Creating a simple Jenkins job that takes 5 minutes to set up, your APEX application will be monitored 24 hours a day, and you will get alerted as soon as it becomes unavailable.  You can then build on this using free open source software to run web (Selenium) and database (JMeter) tests on your APEX app controlled by Jenkins, which will I describe in upcoming posts.

In upcoming posts, I will show you how to set up Jenkins to;

Run web (Selenium) tests on your APEX application.  Schedule web tests logging into your APEX app running tests using Selenium and Maven and get notified of any failures.

Schedule deployment of your APEX dev env nightly to a test env. Deploy your APEX app from your development environment to a test environment nightly, then run a suite of Selenium web tests and get notified of any failures.

Monitor your APEX DB. Run scheduled database checks on your APEX database using JMeter and get notified of any failures.

Load test your APEX app. Stress test your APEX application, logging in with thousands of users using JMeter distributed testing.

In this post I will also create a job to monitor our Apex Office Print server and get alerted if it's unavailable.  These are the 2 Jenkins monitoring jobs I am going to set-up;

Prerequisite: Install Jenkins and the site monitor plugin.  Jenkins is simple to set up and there are lots of online guides, so I won't go into it here.

Let's set up the monitor APEX application job.  Log into Jenkins and press New Item (top left);


name it "Monitor APEX application", select Freestyle project and press OK;



press configure;

set-up  how often we want to monitor our APEX app, which will be every 5 minutes; 

H/5 * * * *


(press the blue ? beside to the right of schedule to get help on setting up the schedule cron)

Now tell it the APEX URL you want to monitor by pressing Add post-build action;

and choose Monitor Site;

the URL is your APEX app URL;


You can leave Success Response Codes empty, where it will check for 2XX codes by default.

Lastly, set up the email recipients who will get emailed if the app is unavailable;


Exactly the same steps for the Monitor AOP job, replacing the APEX URL with our AOP Server address.

It's free and took about 5 minutes to set the jobs up, my team now get alerted as soon as our APEX app or AOP server is unavailable. I have found this invaluable, as we now get alerted if there is an issue with our application, so we can try and fix it before any users report it.









Comments

Post a Comment

Popular posts from this blog

Oracle APEX Interactive Grid colour cells based on a condition using JavaScript and CSS

Image
In this post I will describe how to colour an Interactive Grid based on a column condition using CSS and JavaScript.  Using APEX Version 19.2. I want to colour every column red in my IG when the value is 'No'.   I have several IGs on my page I want to colour, so I set all my IGs that I want to colour with a CSS class of ATTENDEE_SCORE_IG in the Appearance section of the IG; Every column I want to colour in the IG I set the CSS Class to COLOUR_YES_NO (in this example I set this in 5 columns); I then created a Dynamic Action (DA) that contains the JavaScript that has the condition check that will colour the cells.  Because I have several IGs that are details of the master/detail relationship and these are refreshed by the user clicking on the master detail IG I have made my DA a Page Change [Interactive Grid].  If you don't need this you can set the DA on page load. The JS which will colour every column is this; ////////////////////////////////////////////////////////////////
Read more

Oracle APEX pretty checkbox item plugin

Image
Following on from the animated on off button this is now an item plugin.  Pretty up your checkboxes..... You have 16 checkbox types to choose from where you can control the size and colour of the checkbox in item settings; demo Create a page item with type Pretty check box Choose type of checkbox Set checkbox attributes. How it works The item plug in code uses this code to plug the rendered checkbox into APEX. /////////////////////////////////////////////////////////////////////////////////////////// // glasgow_simple_checkbox // // Provides a plug- in specific implementation for a checkbox item. The item on the page // should be a checkbox, i.e. <input type = "checkbox" and name should be your item name // i.e. name = 'P12_NAME' // // Params // // itemName - the item name , i.e. name = 'P12_NAME' // checkboxValues - the check and unchecked values , i.e. Y/N /////////////////////////////////////////////////////////////////////////////////////////// f
Read more

Build beautiful and interactive API documentation for ORDS

Image
In this blog post, I will show you how to quickly build beautiful and interactive API documentation for your Oracle APEX REST data sources using  swagger hub . Using APEX v23.1. I downloaded the  titanic data set  and loaded them into tables in my APEX instance, created some authorized restful services and published them using swagger hub. You can create a free account on swagger hub.   Check out my titanic swagger hub here ; Press Authorize. Username REST, password Glasgow123! I won't go through creating RESTful services and just show you the four I created that sit on top of the titanic data set; The GET is a very simple SQL query;      select * from TITANIC_DATA_SET_NEW A handy tip is to add comments, as there will appear on swagger hub, making your API self documenting; Once you have created your modules, press the Generate Swagger Doc button; This will generate an open API for you.  Copy the API and paste it into swagger hub This will generate the documentation; As mentioned b
Read more