How to Generate Full Swagger Doc for Magento 2 REST API

apimagento-2.1rest

I have a fresh Magento 2.1.5 install, and I'd like to access the full swagger spec, like the one published on http://devdocs.magento.com/swagger, but with the Try it Out! buttons enabled.

I've accessed my local swagger spec on http://localhost/magento2/swagger, but the services list isn't complete, when compared to the published on the Magento site.

Best Answer

That's actually correct behavior.

You need to generate API credentials in magento backend, authenticate, and insert token like on the image below:

Token can be obtained from swagger web interface calling integrationAdminTokenServiceV1 or you can authenticate use curl:

curl -XPOST -H 'Content-Type: application/json' http://your-host/index.php/rest/V1/integration/admin/token -d '{ "username": "yourUsername", "password": "yourPassword" }'

Related Solutions

Magento – Magento 2.1.3 Swagger and api error

Swagger try to generate documentation from class annotation.

You use array as API type.

It is not support by Magento swagger implementation.

You can try to use anyType as a workaround or create your custom type.

Reference :

\Magento\Framework\Reflection\TypeProcessor

Allowed base type :

/**#@+
 * Normalized type constants
 */
const NORMALIZED_STRING_TYPE = 'string';
const NORMALIZED_INT_TYPE = 'int';
const NORMALIZED_FLOAT_TYPE = 'float';
const NORMALIZED_DOUBLE_TYPE = 'double';
const NORMALIZED_BOOLEAN_TYPE = 'boolean';
const NORMALIZED_ANY_TYPE = 'anyType';

You can also add array type but you need to do some custom development.

If your website is different than default, you will need to change the form URL hidden value to match your website.

Get Full Product Link via REST API in Magento 2

The full URL is not available as far as I'm aware, but the url_key is. So you could construct the product link from that, i.e:

https://domain.com/product_url_key.html

Best Answer

Related Solutions

Magento – Magento 2.1.3 Swagger and api error

Get Full Product Link via REST API in Magento 2

Related Topic