Style guides are the set of rules that apply to the scanning of APIs.
By default, a style guide is created with the name of the organization that is used by default in all the collections we create that do not have a specific style guide linked to them. However, you can add as many style guides as you want to your organization. All style guides will have all rules enabled by default.
To create more style guides, access this screen from the configuration menu and click on the Create Style Guide button.
Within the creation dialog, we will be asked to enter a name for the style guide and to check if we want this new guide to be used by default in case we do not link any to the API collections.
If everything went well, the following message is displayed:
If we need to make changes to a style guide, we can modify it by clicking on the pencil icon or delete it by clicking on the trash can icon:
Style guide rules #
The style guide rules analyze API definitions, ensuring that they follow specific standards and best practices, guaranteeing correct functionality and consistency.
You can display the rules belonging to a particular style guide by clicking on its name.
From this screen, you can configure the rules that will be used to scan an API with the selected style guide, modify the parameter values in those rules that allow it, etc.
We can activate and deactivate as many rules as we want, taking into account that only those that are active can be edited.
In the editing dialog, we can modify the severity of the rule, as well as the associated parameters. Once the necessary changes have been made, click on Edit rule to save.
