Fix APIs in Eclipse
In Eclipse IDE, the OpenAPI (Swagger) Editor extension makes creating and navigating OpenAPI definitions quicker and easier, and you can run Security Audit directly from the editor. You can fix the issues that Security Audit found and then upload the updated API definition to 42Crunch Platform.
The issues represent real concerns in your OpenAPI definition, and they may either prevent API Protection completely, or severely impact its quality. We highly recommend that you fix all found issues.
- Install OpenAPI (Swagger) Editor extension to your Eclipse editor.
- Open the API you want in Eclipse in
- To run Security Audit from Eclipse, click the 42C button at the top edge of the workbench. Security Audit checks your API definition and provides audit score and report on the found issues in the editor just like in the platform. The elements containing issues are also marked in your code. For more details, see Audit report in Eclipse.
The extension uses a token to authenticate to Security Audit. On the first time, you must provide your email address so that we can send you the token, just follow the instructions on the UI. Configuring the token is done only once, on subsequent audits you just click the button.
- In the Problems view, scroll through the issue titles, and click on an issue to jump to view it inline in your API definition. The issues are ordered from most to least severe, so it is easy for fix the worst offenders first. Recommendations are not listed in the Problems panel.
- Hover on an element marked in your code to see the list of issues in that spot, and click on the list to filter the text panel to show only these issues.
- Edit your API definition to fix found issues, save your changes, and click the 42C button to re-run the audit.
After you have edited the OpenAPI definition of your API in Eclipse, you can upload the updated API definition to 42Crunch Platform without reimporting the API.
Uploading a new API definition for an imported API overwrites the API definition currently stored in 42Crunch Platform. If you have also edited the OpenAPI definition in Security Editor, these changes are lost if you have not included them in the file you are uploading.
- Go to the API you want to update, and click > Update definition.
- Select the file to upload.
- Click Update definition.
The OpenAPI definition of the API you selected in 42Crunch Platform is replaced with the one you uploaded. Security Audit audits the uploaded API definition and recalculates the audit score for the API.
Uploading an API definition changes the format (JSON or YAML) of the API in the platform to match the uploaded file. If you upload a
.json file, the API definition in the platform will now be in JSON format. Same applies uploading a YAML file. You can switch between the JSON and YAML format as needed, see Convert APIs.
You can also integrate Security Audit with your CI/CD pipeline so that any changes to APIs in your project are automatically audited for security. For more details, see CI/CD integrations.