API Hub for Design UI Overview

API Hub for Design lets you create, edit and host OpenAPI and AsyncAPI definitions, collaborate on them with your team and integrate them with third-party services.

Anonymous users can browse and search the public API catalog. Logged in users can also view private APIs as well as create and edit API definitions.

API Hub for Design Catalog

When you are logged in to API Hub for Design, you see all the APIs you have access to – public and private, created by you and shared with you. If you are new to API Hub for Design and have no APIs yet, the list will be empty, but it will change once you start creating APIs.

API_screenshot_my_APIs_01.png

APIs and domains

There are three types of definitions on API Hub for Design – APIs, domains, and templates. APIs and domains have the corresponding label in the list.

A domain is a collection of shared components, such as model definitions and operation parameters, that can be used in different APIs. A template is used to facilitate API creation and can be selected in the Create API modal. Templates are predefined, although you can also create custom templates.

Public, private, published, and unpublished

All definitions are labeled Public or Private, and Published or Unpublished. These terms mean different things:

  • Public and Private indicate visibility. Pubic definitions can be seen by anyone, private definitions are visible only to the selected collaborators. See Public and Private APIs.

  • Published and Unpublished indicate maturity or completeness. Unpublished definitions are work in progress, published definitions are not supposed to change and are ready for consumption. See Publishing an API.

Interact with the API list

  • Click the API or domain title to open it.

  • Click the owner name (in the leftmost column) to filter the definitions by that owner.

  • Sort and filer the displayed definitions, or use the corresponding search filters.

  • Click share.png to copy the link to the API or domain. If you are the owner, the displayed dialog also lets you invite collaborators to this API or domain.

  • Click anywhere on the row to open the Details pane. The details include the full description, creation date, and last update date.

API_screenshot_open_API_01.png

Create APIs

Use the Create New menu to create new APIs, domains and organizations.

API_screenshot_create_API_01.png

Once you create an API or domain, you can write its API definition in the API Hub for Design Editor. Here you can also preview the generated API documentation, test API calls and configure integrations.

API_screenshot_API_edit_panel_01.png

More info:

Organizations

The Organizations section in the sidebar lists all the organizations you created or joined. Organizations are groups of users working together on API definitions. A user can be a member of multiple organizations.

Click an organization to see all of its APIs and domains you have access to. If you are the organization owner, you can access the organization settings by clicking next to the organization name in the sidebar.

API_screenshot_manage_projects_02.png

More info: Managing Resource Access.

Settings

The menu under your username lets you access your account settings. You can use it to change your email or password, rename your account, manage your organizations, and so on.

More info: Account Settings.

Publication date: