Publish Docs to a Developer Portal

This document provides instructions on how to publish API documentation and API proxies to a Developer Portal in order to make them available at a designated hostname.


This documentation applies to NGINX Management Suite API Connectivity Manager 1.1.0 and later.


Overview

This document will guide you through the process of publishing API documentation and API proxies to a Developer Portal. You will find instructions on how to add an API spec file, publish API documentation and the associated API proxy, or publish API documentation only. After completing these steps, you should be able to access your API and documentation at the designated hostname.


Before You Begin

To complete the steps in this guide, you need the following:


How to Access the User Interface

This guide provides instructions for completing tasks using the NGINX Management Suite API Connectivity Manager user interface (UI).

To access the UI, go to the FQDN of your NGINX Management Suite host and log in. On the Launchpad menu, select “API Connectivity Manager.”


Add an API Doc

  1. On the sidebar, select Services.
  2. Select your workspace.
  3. Select API Docs > Add API Doc.
  4. Browse your local filesystem and select the API Spec in YAML or JSON format that you’d like to upload.
  5. Select Save.

Publish the API Documentation and API Proxy

  1. Select Services on the sidebar.
  2. Select your workspace from the Workspaces list.
  3. On the API Proxies section, select Publish to Proxy.
  4. On the Name box, type the name for the backend service. -svc will be added to the name automatically.
  5. On the Service Target Hostname, type the hostname for the Service Target.
  6. On the API Proxy section, the Name box is automatically filled.
  7. On the API Spec section, select your spec using the list.
  8. Select your Gateway Proxy Hostname using the list.
  9. Confirm the Base Path and Version on the Ingress section. Update the default values if needed.
  10. Check the Also publish API to developer portal box on the Developer Portal section.
  11. Select the Portal Proxy Hostname using the list.
  12. Select Publish

The API and documentation should now be available at the hostname provided for the Developer Portal proxy.

Publish the API Documentation Only

Take the steps below to publish just the API documentation.

  1. Select Services on the sidebar.
  2. Select Publish API Doc from the Actions menu.
  3. In the Name box, type the name for your API Doc.
  4. On the API Spec section, select your spec using the list.
  5. Select the Portal Proxy Hostname using the list.
  6. Confirm the Base Path and Version on the Ingress section. Update the default values if needed.
  7. Select the Enter an external Hostname option.
  8. On the External Hostname section, provide the hostname for your external Target Proxy.
  9. Select Save.