Forum Discussion

TanyaYatskovska's avatar
TanyaYatskovska
SmartBear Alumni (Retired)
6 years ago

[September Hub-bub] What are your “must-have” principles in creating API documentation?

Hey Guys,   Today’s topic should be extra helpful to new users, and it should bring lots of useful discussions for skilled users. Let’s talk about the best practices in creating API documentation...
SeptemberHubbub
Nastya_Khovrina's avatar
Nastya_Khovrina
SmartBear Alumni (Retired)
6 years ago

For the users on the Enterprise plan, the API Standardization feature is available. This feature provides various rules (“must-have” principles) to check the operations, parameters and model definitions for compliance so you can ensure that your OpenAPI definitions comply with your company’s API style guide. You can read more about it here: https://app.swaggerhub.com/help/organizations/api-standardization.