I’m developing an API using RapidAPI, and upon uploading my OpenAPI specification, I notice that the API names in the web interface are derived from the OpenAPI spec’s operationId
, which is typically formatted in camelCase. I’m looking for a method to display these names in a more user-friendly format while still maintaining the original camelCase structure of the operationId.
For instance, consider this OpenAPI PetStore OAS3 example:
paths:
/pets:
get:
summary: Retrieve all pets
operationId: retrievePets
tags:
- pets
As it stands, the operationId
value, retrievePets
, is shown in the navigation menu of the HTML interface, but I prefer an output where it is formatted in a more human-readable manner, similar to how other APIs on RapidAPI are displayed. Although some OpenAPI tools utilize the summary
property (which is “Retrieve all pets” here) for user-friendly naming, RapidAPI seems not to support this by default.
As a comparison, the RapidAPI Community Open Weather Map API presents a name like “Current Weather Data.” Is there a way within the OpenAPI spec to achieve a human-readable name in the RapidAPI web UI without altering the operationId to a non-standard string? Specifically, can another field be utilized to incorporate the summary
property?