Making RapidAPI endpoint names user-friendly when importing OpenAPI specifications

Other Questions RapidAPI
1

I’m working with RapidAPI and uploading OpenAPI specifications. The problem is that when I import my spec file, the endpoint names in the interface use the operationId values which are typically written in camelCase format. I want to display readable names with proper spacing while keeping my operationId in the standard camelCase style.

For instance, here’s a sample from my API specification:

endpoints:
  /products:
    get:
      description: Retrieve all products
      operationId: getAllProducts
      categories:
        - inventory

Currently this shows up as “getAllProducts” in the RapidAPI navigation menu, but I’d prefer it to display as “Retrieve all products” using the description field instead.

I’ve noticed other APIs on RapidAPI have nice formatted names like “Weather Forecast Data” in their left sidebar. Is there a specific field or configuration in the OpenAPI spec that tells RapidAPI to use the description or summary field for display purposes instead of the operationId? I want to avoid changing my operationId to non-standard formatting just for display purposes.

2

RapidAPI’s display hierarchy works in a specific order - I figured this out through trial and error with my own APIs. When it processes your OpenAPI spec, it looks for the summary field first for navigation display names. No summary? It falls back to description. Still nothing? Then it uses operationId as a last resort.

Your example has a description but you’re missing the summary field. Just add summary: "Get All Products" above or below your description line. Keep the summary short and user-friendly since that’s what people see, while your description can stay detailed for documentation.

This way you keep your camelCase operationId for code generation but get clean display names in RapidAPI’s interface.

3

you can try adding a summary field to your endpoint. i had the same problem and it worked for me. rapidapi shows that over operationId if it exists. if not, it uses the description then operationId. hope this helps!

4

Hit this same problem last month with my first RapidAPI publish. RapidAPI uses the summary field for sidebar navigation names. Caught me off guard since OpenAPI 3.0 makes summary optional, but RapidAPI really needs it for proper formatting.

Add it to your YAML like this:

get:
  summary: Get All Products
  description: Retrieve all products
  operationId: getAllProducts

RapidAPI displays title case better than sentence case in summaries. “Get All Products” looks cleaner than “Get all products” in their interface. The description field still works for detailed docs when developers click into endpoint details.