{"id":1073,"date":"2020-05-01T11:01:51","date_gmt":"2020-05-01T10:01:51","guid":{"rendered":"https:\/\/42crdev.prexihost.com\/?p=1073"},"modified":"2023-12-06T10:33:36","modified_gmt":"2023-12-06T10:33:36","slug":"tutorial-security-audit-openapi-swagger-extension-vs-code","status":"publish","type":"post","link":"https:\/\/staging2022.42crunch.com\/tutorial-security-audit-openapi-swagger-extension-vs-code\/","title":{"rendered":"API Security Audit using OpenAPI Swagger Editor Extension in VS Code"},"content":{"rendered":"\r\n\r\n\t<p>Tutorials<\/p>\r\n\r\n\t<section>\r\n<section>\r\n<p>Identify and fix issues in the OpenAPI (formerly Swagger) definition file using the <a href=\"https:\/\/42crunch.com\/api-security-audit\/\">API Audit<\/a>, available via the OpenAPI Editor in Microsoft Visual Studio Code (VS Code).<\/p>\r\n<\/section>\r\n<\/section>\r\n\t<iframe src=\"https:\/\/player.vimeo.com\/video\/873235173?badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479\" frameborder=\"0\" allowfullscreen=\"allowfullscreen\"><\/iframe>\r\n<h2>\r\n\t\tReviewing The Score\r\n\t<\/h2>\r\n\t<section>\r\n<p><a href=\"https:\/\/staging2022.42crunch.com\/api-security-audit\/\">API audit<\/a> runs over 300 different checks and provides an overall score that represents the quality of your OpenAPI definition. Learn more by viewing the explanatory video.<\/p>\r\n<\/section>\r\n\t<iframe src=\"https:\/\/player.vimeo.com\/video\/889786439?h=ab59a24cfa&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479\" frameborder=\"0\" allowfullscreen=\"allowfullscreen\"><\/iframe>\r\n\t<iframe src=\"https:\/\/player.vimeo.com\/video\/889791444?h=f8a250e41a&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479\" frameborder=\"0\" allowfullscreen=\"allowfullscreen\"><\/iframe>\r\n<h2>\r\n\t\tFiltering The Audit Report\r\n\t<\/h2>\r\n\t<section>\r\n<p>There are a number of ways to filter the results from the audit report. More in details in the video.<\/p>\r\n<\/section>\r\n<h2>\r\n\t\tAuditing API Operations\r\n\t<\/h2>\r\n\t<section>\r\n<p>For each operation in your OpenAPI file you have the ability to run the audit just on that single operation.<\/p>\r\n<\/section>\r\n\t<iframe src=\"https:\/\/player.vimeo.com\/video\/889795114?h=0139c5fa3f&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479\" frameborder=\"0\" allowfullscreen=\"allowfullscreen\"><\/iframe>\r\n\t<iframe src=\"https:\/\/player.vimeo.com\/video\/889802638?h=58146a9249&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479\" frameborder=\"0\" allowfullscreen=\"allowfullscreen\"><\/iframe>\r\n<h2>\r\n\t\tFixing Audit Issues\r\n\t<\/h2>\r\n\t<section>\r\n<p>How to work through the Audit report to fix identified issues starting with the critical ones.<\/p>\r\n<\/section>\r\n<h2>\r\n\t\tUsing &#8220;Quickfix&#8221; Automations\r\n\t<\/h2>\r\n\t<section>\r\n<p>In many cases you will see the option to use a &#8220;Quickfix&#8221; for identified issues. This is where our tool will automatically add the appropriate fields or insert a template into the OpenAPI definition. There is also a &#8220;group fix&#8221; option where all of the same issues can be fixed in one go.<\/p>\r\n<\/section>\r\n\t<iframe src=\"https:\/\/player.vimeo.com\/video\/889809116?h=e3d93c8523&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479\" frameborder=\"0\" allowfullscreen=\"allowfullscreen\"><\/iframe>\r\n\r\n","protected":false},"excerpt":{"rendered":"<p>Tutorial on how to run the 42Crunch API security audit from the OpenAPI (Swagger) Editor extension in VS Code and how to navigate the report.<\/p>\n","protected":false},"author":4,"featured_media":12267,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_seopress_robots_primary_cat":"none","_seopress_titles_title":"API Audit on the OpenAPI (Swagger) Editor Extension for VS Code ","_seopress_titles_desc":"Tutorial on how to run the 42Crunch API security audit from the OpenAPI (Swagger) Editor extension in VS Code and how to navigate the report.","_seopress_robots_index":"","site-sidebar-layout":"default","site-content-layout":"disabled","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"disabled","ast-hfb-above-header-display":"disabled","ast-hfb-below-header-display":"disabled","ast-hfb-mobile-header-display":"disabled","site-post-title":"disabled","ast-breadcrumbs-content":"disabled","ast-featured-img":"disabled","footer-sml-layout":"disabled","theme-transparent-header-meta":"default","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"set","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"categories":[11],"tags":[22,16,19],"class_list":["post-1073","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-tutorials","tag-api-security-platform","tag-api-security-training","tag-openapi-swagger-editor"],"_links":{"self":[{"href":"https:\/\/staging2022.42crunch.com\/wp-json\/wp\/v2\/posts\/1073"}],"collection":[{"href":"https:\/\/staging2022.42crunch.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/staging2022.42crunch.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/staging2022.42crunch.com\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/staging2022.42crunch.com\/wp-json\/wp\/v2\/comments?post=1073"}],"version-history":[{"count":2,"href":"https:\/\/staging2022.42crunch.com\/wp-json\/wp\/v2\/posts\/1073\/revisions"}],"predecessor-version":[{"id":17782,"href":"https:\/\/staging2022.42crunch.com\/wp-json\/wp\/v2\/posts\/1073\/revisions\/17782"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/staging2022.42crunch.com\/wp-json\/wp\/v2\/media\/12267"}],"wp:attachment":[{"href":"https:\/\/staging2022.42crunch.com\/wp-json\/wp\/v2\/media?parent=1073"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/staging2022.42crunch.com\/wp-json\/wp\/v2\/categories?post=1073"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/staging2022.42crunch.com\/wp-json\/wp\/v2\/tags?post=1073"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}