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 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