Build beautiful and interactive API documentation for ORDS

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 before, the comments you add in APEX will appear in the API, self documenting! 


Same for any parameters you create, these are comments I created in APEX for the parameters. Male or female, giving the API user some info on what is required for this parameter;


The real power of swagger hub is it builds client libraries and documentation for your API. Press Export on the top right of the swagger hub page;


For example, choosing Java will download a zip


Giving example code to use your API.

















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 style an Interactive Grid cell conditionally based on the value of another cell using JavaScript and CSS

Image
This blog post describes how you can style an Interactive Grid cell conditionally based on the value of another cell using JQuery and CSS.  Using APEX Version 19.2. The requirement is to highlight the cell that has the highest value in the row; This can be achieved by setting the IG column CSS class and using JQuery to loop round the table rows to conditionally set CSS style based on cell values First give all your columns a CSS Class (note you can give columns multiple classes separated with space) in this case all 4 columns are set with CSS class SCORE_C_1, SCORE_C_2, SCORE_C3 and SCORE_C_4 in the column Appearance; We now add the JavaScript in Execute when page loads (preferably put this is a JS file). We are using the JQuery $.each() method to fetch every table row;  $.each($('tbody tr'), function(i, item) {} and the JQuery text() method to get the column value from the row using the column CSS class names;         var scoreC1 = $(item).find('.SCOR...
Read more

Oracle APEX Color Interactive Grid (IG) group header using CSS

Image
  This post describes how to colour a group header on an Interactive Grid.  Using Version 19.2 but this should work on all versions. Groups are when you create a group and place columns into the group like this; I want to colour the Research & Teaching Group header to be this; Open the page containing the IG and open Developer tools in Chrome then click on the selector tool (arrow top left). Click the region you header you want to style, in my case Research & Teaching UoFGS.  In developer tools right click on the selected element and copy the selector. This gets copied; #rgBenchmarkingIG_ig_grid_vc > div.a-GV-hdr.js-stickyWidget-toggle > div.a-GV-w-hdr > table > thead > tr:nth-child(1) > th:nth-child(2) I dont only want to colour the selected column I want to colour the whole row, so I remove; > th:nth-child(2) and place the following CSS into inline CSS or preferably a CSS file; #rgBenchmarkingIG_ig_grid_vc > div.a-GV-hdr.js-stickyWidget...
Read more