{"id":84387,"date":"2017-05-20T15:13:20","date_gmt":"2017-05-20T15:13:20","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=84387"},"modified":"2024-03-06T08:54:46","modified_gmt":"2024-03-06T08:54:46","slug":"magento2-swagger-ui","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/","title":{"rendered":"Magento 2 RESTful API with Swagger UI"},"content":{"rendered":"\n

Today we are going to understand how to use magento2 swagger ui, magento 2 provides REST API for accessing magento resources from any other devices, magento 2 REST API<\/a> is based on OpenAPI Specification(OAS) (or Swagger Specifications), OAS are meant for how we can describe, structure, and visualize api resources.<\/p>\n\n\n\n

Any one who follows swagger specifications can easily use many open source tools to automatically generate API documentation, code and test cases. Swagger specifications are meant for standardising the RESTful API  development and consumption.<\/p>\n\n\n\n

You can learn more about swagger specifications from here:<\/p>\n\n\n\n

http:\/\/swagger.io\/specification\/<\/a><\/p>\n\n\n\n

Magento 2 RESTful API is based on swagger specification and uses swagger ui tool<\/a> to generate and visualize API documentation so it can be easily understood and used.<\/p>\n\n\n\n

Magento 2 provides Magento_Swagger module to list, visualize and at the same time test the API resources.<\/p>\n\n\n\n

If you have installed Magento 2 on your server then you can easily access all the api resouces listed on your website by just hitting this url:<\/p>\n\n\n\n

http:\/\/website-base-url\/swagger<\/p>\n\n\n\n

example: http:\/\/www.xyz.com\/swagger<\/p>\n\n\n\n

after hitting the above url you will see this interface:<\/p>\n\n\n\n

\"swa-1\"<\/figure>\n\n\n\n

All the API resources will be listed like in the above image, you can click on each resource to check all the details about the api, resource url, method, params and even you can execute the API call on the same place and check the response.<\/p>\n\n\n\n

You will be thinking, with this help anyone can check any details on your Magento 2 website by just going though the swagger link, but that’s not the case, you can only have guest level resources from here, untill you provide a valid api key.<\/p>\n\n\n\n

Using Magento 2 token based authentication<\/a> you can generate api key, and use that api key directly on swagger interface to access even restricted resources.<\/p>\n\n\n\n

Suppose you are an admin and want to test admin level resources and test them directly on swagger interface, first you need to generate admin level access key with following command with cURL like below:<\/p>\n\n\n\n

curl -XPOST -H 'Content-Type: application\/json' http:\/\/magento-url\/rest\/V1\/integration\/admin\/token -d '{ "username": "user-name", "password": "admin-password" }'<\/pre>\n\n\n\n
Then you will get the access key to access admin level resource, you can fill the API key in the swagger ui to access the resources like below:<\/p>\n\n\n\n
\"sw\"<\/figure>\n\n\n\n
After filling the api key click on apply and you will get admin level access in the swagger ui. Same goes for accessing customer level resources just generate the customer level access key and use it on the swagger ui.<\/p>\n\n\n\n
Hope it will help you if you are trying to use Magento2 REST API.<\/p>\n\n\n\n
Thanks \ud83d\ude42<\/p>\n","protected":false},"excerpt":{"rendered":"
Today we are going to understand how to use magento2 swagger ui, magento 2 provides REST API for accessing magento resources from any other devices, magento 2 REST API is based on OpenAPI Specification(OAS) (or Swagger Specifications), OAS are meant for how we can describe, structure, and visualize api resources. Any one who follows swagger […]<\/a><\/p>\n","protected":false},"author":33,"featured_media":73740,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[302],"tags":[],"class_list":["post-84387","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-magento2"],"yoast_head":"\nMagento 2 RESTful API with Swagger UI - Webkul Blog<\/title>\n<meta name=\"description\" content=\"Magento2 RESTful API is based on swagger specification and uses swagger ui tool to generate and visualize API documentation so it can be easily understood and used.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Magento 2 RESTful API with Swagger UI - Webkul Blog\" \/>\n<meta property=\"og:description\" content=\"Magento2 RESTful API is based on swagger specification and uses swagger ui tool to generate and visualize API documentation so it can be easily understood and used.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/\" \/>\n<meta property=\"og:site_name\" content=\"Webkul Blog\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/webkul\/\" \/>\n<meta property=\"article:published_time\" content=\"2017-05-20T15:13:20+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-03-06T08:54:46+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2017\/02\/Magneto-Code-Snippet-1.png\" \/>\n\t<meta property=\"og:image:width\" content=\"825\" \/>\n\t<meta property=\"og:image:height\" content=\"260\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Ashutosh Srivastava\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@webkul\" \/>\n<meta name=\"twitter:site\" content=\"@webkul\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Ashutosh Srivastava\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/\"},\"author\":{\"name\":\"Ashutosh Srivastava\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/5555025750ec4e4df34fadc78b083970\"},\"headline\":\"Magento 2 RESTful API with Swagger UI\",\"datePublished\":\"2017-05-20T15:13:20+00:00\",\"dateModified\":\"2024-03-06T08:54:46+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/\"},\"wordCount\":424,\"commentCount\":2,\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2017\/02\/Magneto-Code-Snippet-1.png\",\"articleSection\":[\"Magento2\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/\",\"url\":\"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/\",\"name\":\"Magento 2 RESTful API with Swagger UI - Webkul Blog\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2017\/02\/Magneto-Code-Snippet-1.png\",\"datePublished\":\"2017-05-20T15:13:20+00:00\",\"dateModified\":\"2024-03-06T08:54:46+00:00\",\"description\":\"Magento2 RESTful API is based on swagger specification and uses swagger ui tool to generate and visualize API documentation so it can be easily understood and used.\",\"breadcrumb\":{\"@id\":\"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/#primaryimage\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2017\/02\/Magneto-Code-Snippet-1.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2017\/02\/Magneto-Code-Snippet-1.png\",\"width\":825,\"height\":260},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webkul.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Magento 2 RESTful API with Swagger UI\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/webkul.com\/blog\/#website\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"name\":\"Webkul Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/webkul.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/webkul.com\/blog\/#organization\",\"name\":\"WebKul Software Private Limited\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"width\":380,\"height\":380,\"caption\":\"WebKul Software Private Limited\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/webkul\/\",\"https:\/\/x.com\/webkul\",\"https:\/\/www.instagram.com\/webkul\/\",\"https:\/\/www.linkedin.com\/company\/webkul\",\"https:\/\/www.youtube.com\/user\/webkul\/\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/5555025750ec4e4df34fadc78b083970\",\"name\":\"Ashutosh Srivastava\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/2f5312e6903909ffeb33aa5eb38e1c0bed8f498f92144f5f84065adf7e8708a6?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/2f5312e6903909ffeb33aa5eb38e1c0bed8f498f92144f5f84065adf7e8708a6?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"caption\":\"Ashutosh Srivastava\"},\"sameAs\":[\"http:\/\/webkul.com\"],\"url\":\"https:\/\/webkul.com\/blog\/author\/ashutosh\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Magento 2 RESTful API with Swagger UI - Webkul Blog","description":"Magento2 RESTful API is based on swagger specification and uses swagger ui tool to generate and visualize API documentation so it can be easily understood and used.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/","og_locale":"en_US","og_type":"article","og_title":"Magento 2 RESTful API with Swagger UI - Webkul Blog","og_description":"Magento2 RESTful API is based on swagger specification and uses swagger ui tool to generate and visualize API documentation so it can be easily understood and used.","og_url":"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/","og_site_name":"Webkul Blog","article_publisher":"https:\/\/www.facebook.com\/webkul\/","article_published_time":"2017-05-20T15:13:20+00:00","article_modified_time":"2024-03-06T08:54:46+00:00","og_image":[{"width":825,"height":260,"url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2017\/02\/Magneto-Code-Snippet-1.png","type":"image\/png"}],"author":"Ashutosh Srivastava","twitter_card":"summary_large_image","twitter_creator":"@webkul","twitter_site":"@webkul","twitter_misc":{"Written by":"Ashutosh Srivastava","Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/#article","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/"},"author":{"name":"Ashutosh Srivastava","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/5555025750ec4e4df34fadc78b083970"},"headline":"Magento 2 RESTful API with Swagger UI","datePublished":"2017-05-20T15:13:20+00:00","dateModified":"2024-03-06T08:54:46+00:00","mainEntityOfPage":{"@id":"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/"},"wordCount":424,"commentCount":2,"publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"image":{"@id":"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/#primaryimage"},"thumbnailUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2017\/02\/Magneto-Code-Snippet-1.png","articleSection":["Magento2"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/webkul.com\/blog\/magento2-swagger-ui\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/","url":"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/","name":"Magento 2 RESTful API with Swagger UI - Webkul Blog","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/#primaryimage"},"image":{"@id":"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/#primaryimage"},"thumbnailUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2017\/02\/Magneto-Code-Snippet-1.png","datePublished":"2017-05-20T15:13:20+00:00","dateModified":"2024-03-06T08:54:46+00:00","description":"Magento2 RESTful API is based on swagger specification and uses swagger ui tool to generate and visualize API documentation so it can be easily understood and used.","breadcrumb":{"@id":"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webkul.com\/blog\/magento2-swagger-ui\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/#primaryimage","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2017\/02\/Magneto-Code-Snippet-1.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2017\/02\/Magneto-Code-Snippet-1.png","width":825,"height":260},{"@type":"BreadcrumbList","@id":"https:\/\/webkul.com\/blog\/magento2-swagger-ui\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webkul.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Magento 2 RESTful API with Swagger UI"}]},{"@type":"WebSite","@id":"https:\/\/webkul.com\/blog\/#website","url":"https:\/\/webkul.com\/blog\/","name":"Webkul Blog","description":"","publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/webkul.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/webkul.com\/blog\/#organization","name":"WebKul Software Private Limited","url":"https:\/\/webkul.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","width":380,"height":380,"caption":"WebKul Software Private Limited"},"image":{"@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/webkul\/","https:\/\/x.com\/webkul","https:\/\/www.instagram.com\/webkul\/","https:\/\/www.linkedin.com\/company\/webkul","https:\/\/www.youtube.com\/user\/webkul\/"]},{"@type":"Person","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/5555025750ec4e4df34fadc78b083970","name":"Ashutosh Srivastava","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/2f5312e6903909ffeb33aa5eb38e1c0bed8f498f92144f5f84065adf7e8708a6?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/2f5312e6903909ffeb33aa5eb38e1c0bed8f498f92144f5f84065adf7e8708a6?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","caption":"Ashutosh Srivastava"},"sameAs":["http:\/\/webkul.com"],"url":"https:\/\/webkul.com\/blog\/author\/ashutosh\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/84387","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/users\/33"}],"replies":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/comments?post=84387"}],"version-history":[{"count":8,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/84387\/revisions"}],"predecessor-version":[{"id":426229,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/84387\/revisions\/426229"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media\/73740"}],"wp:attachment":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media?parent=84387"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/categories?post=84387"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/tags?post=84387"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}