Displaying user-friendly API names in RapidAPI from OpenAPI specification

Other Questions RapidAPI
1

I’ve been working on an API using RapidAPI. When I upload my OpenAPI spec, the web UI shows API names based on the operationId, which is usually in camelCase. This doesn’t look great for users.

For example, if I have an API endpoint like this:

paths:
  /user-data:
    get:
      summary: Fetch user information
      operationId: getUserInfo
      tags:
        - users

The UI displays ‘getUserInfo’ instead of something more readable like ‘Fetch user information’.

I’ve noticed other APIs on RapidAPI have nicer names in their navigation. Is there a way to make my API names more user-friendly without changing the operationId? Maybe RapidAPI can use a different field from the OpenAPI spec?

Any tips on how to improve this would be really helpful. Thanks!

2

I’ve encountered a similar situation with RapidAPI and learned that using the ‘summary’ field in the OpenAPI spec can often serve as a better display name than the operationId. In practice, the summary tends to be prioritized by the UI, offering a more user-friendly label. If your API still appears with the operationId, it might be worthwhile to check your RapidAPI settings or contact support. I’ve also found that combining a clear summary with the existing operationId helps maintain internal consistency while improving usability.

3

From my experience working with RapidAPI, I’ve found that the ‘x-displayName’ extension can be quite useful for this purpose. You can add it to your OpenAPI spec like this:

paths:
  /user-data:
    get:
      summary: Fetch user information
      operationId: getUserInfo
      x-displayName: 'Get User Info'
      tags:
        - users

This allows you to keep your operationId for internal use while providing a more user-friendly display name. It’s worth noting that not all OpenAPI tools support this extension, but RapidAPI does recognize it. If you’re still having issues after implementing this, reaching out to RapidAPI support might be your best bet for a definitive solution.