Fixing Security Issues in Your OpenAPI File
In our previous tutorial, we took a look at the audit report from API Contract Security Audit. This one proceeds onto fixing the issues found in the audit and see how we can iteratively work on our OpenAPI / Swagger definition.
The best place to start are the high priority issues, they are the fastest way to improve the audit score. For example, in the audit report, click Go to Issue on the first issue in the priority list. You get a view similar to the image on the right.
Here we can see we have seven different places where the issue in question occurs (1) . To go and fix the issue in this particular place, click on Fix issue in Editor (2) . This takes you to the correct spot in your API definition in our built-in Security Editor (3) . By default, the details of the issue and remediation recommendations are shown on the right, but if you have minimized the sidebar, just click How to Fix to view them again.
In our example, you can see that the property maxLength of the string is missing and the remediation suggestions on the right (1). Once you have edited the file to fix the issue, click Save and Re-Test to update the OpenAPI (Swagger) definition.
The issue is fixed, audit is re-run, and the audit score increases accordingly (3).
You can continue to move down the list from here to fix the highest priority issues, or return back to your report and filter the issues as you want.
Updating the Definition
You can work on your API outside 42Crunch Platform as well, like in your IDE or any other editor, and then upload the updated definition manually in the platform. Or you can automate a workflow to push your changes to your API to the platform as well.
Tutorials: In our next tutorial we'll check out the OpenAPI extension for VS Code
Want to learn more? Here are some resources to help you out!