Step 11 - Push API documentation into the API DevPortal

Create the API DevPortal

1. Select APIs -> Dev Portals -> Create Dev Portal. Use the following values:
   1. Name: portal-api-sentence
   2. Environment: env-prod
   3. Gateways: devportal-gw
   4. Published APIs: Select All
   5. Click Next
   6. Brand Name: API Sentence
2. Click Submit

Note

At this stage, the Nginx-2 instance has been configured as an NGINX Web Server with the API Sentence documentation.

Note

The documentation is part of the OpenAPI file we imported at the early steps when we created the API Definition. You can check it here: https://app.swaggerhub.com/apis/F5EMEASSA/API-Sentence/3.0#free If you look at the OAS spec file, you’ll notice some examples. These examples are used by the API DevPortal to automatically generate the API documentation.

examples:
  '0':
    value: '{"name":"lake","coordinates":[-142.28261413,53.28261413]}'

Navigate to the API DevPortal

1. RDP to the Win10 VM (user/user).

2. Open the Edge Browser and select the Dev Portal bookmark.

3. You should see one API, api-sentence-app, click on the``Explore APIs`` button.

4. You can now navigate through your API’s documentation. Click on the several links and menus to discover what the DevPortal offers.

   

5. You can select a VERSION on the left menu. VERSION 3.0 is the version with the coordinates object in the /locations API endpoint.

   

6. To view a specific endpoint, you can either select it on the left side menu, or navigate down the main screen and select View Docs on the respective endpoints. (See images below for an example with the create a location endpoint.)

   

Note

Feel free to navigate through the API DevPortal and check the specs and examples.