Forum Discussion

Occasional Contributor

4 years ago

Solved

Consistency request: Where should we put operationId?

In an attempt to align ourselves I would like to propose we collectively decide on the location of operationId in an API def: The SwaggerHub example found here: https://swagger.io/docs/specification...

timothymaguire
4 years ago
Hi alex-savage

Thanks for the question. API standardization is one of the most important aspects of consistent API design and SwaggerHub has tools to help you do just that. At SmartBear, we tend to put the OperationID right after the method name and have created a custom rule to enforce this in SwaggerHub. You can view this rule and other in our public repo.

API Standardization: https://app.swaggerhub.com/help/organizations/api-standardization

GitHub Rules Library: https://github.com/SmartBear/swaggerhub-custom-rules-library

Feel free to try out these rule and tweak them as needed for your personal preference.

Hope this helps,

Tim

timothymaguire

SmartBear Alumni (Retired)

Hi alex-savage

Thanks for the question. API standardization is one of the most important aspects of consistent API design and SwaggerHub has tools to help you do just that. At SmartBear, we tend to put the OperationID right after the method name and have created a custom rule to enforce this in SwaggerHub. You can view this rule and other in our public repo.

API Standardization: https://app.swaggerhub.com/help/organizations/api-standardization

GitHub Rules Library: https://github.com/SmartBear/swaggerhub-custom-rules-library

Feel free to try out these rule and tweak them as needed for your personal preference.

Hope this helps,

Tim