Create an API Portal

This step in the walkthrough assumes that you have API Version Owner permissions to the T-Shirt Ordering Service API, or that you are an Organization Administrator.

Creating a New API Portal

To get started, access the API Version Details page by clicking here, selecting APIs, and selecting your API.

On the API Version Details page for your T-Shirt Ordering Service API, select Create new Portal from the dropdown menu. This page can be accessed from here by clicking APIs and selecting your API or adding a new one.

The Anypoint Platform takes you directly into the editing mode for your new API Portal. By default, you land on a pre-created Home page that contains the description you entered when you created the API in the platform. You can edit this text and add any additional text you want, using markdown.

If you like, create additional markdown pages using the Add new menu on the left of the page. You can also place external links directly in your left navigation.

You may also create headers to separate out content in your left navigation to make it easier to find. For instance, you might want to separate out your external links in a separate section. Click Add new > Section header and enter a title for the header, such as Resources. You can drag your section heading or any other left nav item up or down to reorder them.

Any changes you make to your left navigation are automatically saved. Changes that you make to your markdown pages need to be saved as drafts and published.

Including an API Console

If you’ve defined your API using RAML before creating your API Portal, your API Console should automatically be included in your API Portal in your left navigation. Click on API reference to view it.

If you created your RAML definition after creating your API Portal, the API Console is not automatically included in the left navigation of your portal. However, you can add it at any time by clicking Add new…​ > API reference.

If you don’t have a RAML definition for your API, consider designing a RAML layer for your existing API to take advantage of this automatic documentation.

Customizing Your API Portal Theme

If you want to, you can adjust the look and feel of your API Portal by accessing the API Portal Theme Settings from the menu in the upper right corner.

Clicking this option opens a theme editor that allows you to customize your logo and color scheme.

Experiment as you wish with adjusting the settings, then click Save when you are satisfied. To view the results, return to your API Version Details page and click View live portal.

Exposing Your API Portal

In order to allow other users to view your portal, you can either make your portal public or give specific users Portal Viewer permissions.

To make your API Portal public, select which items you would like to make public and click the eye ball above.

To add other users as editors of your API Portal, go back to your API Version Details page and click the Permissionstab.

Note that you can only grant permissions to users who are already members of your Anypoint Platform organization. If you need to invite users to the organization, you must ask an Organization Administrator to do so from the Anypoint Organization Administration page.