Swagger doc Shopify

Highlighted
Tourist
27 0 2

Is there any Swagger document available for Shopify APIs?

0 Likes
Highlighted
Shopify Staff
Shopify Staff
486 42 106

Hi @agaonkar,

 

We don't use swagger to document our APIs, but our own in-house documentation which you can view here: https://help.shopify.com/en/api/reference.

Developer Experience @ Shopify
0 Likes
Highlighted
Tourist
4 0 9

@Ryan Please consider using Swagger/OpenAPI. A REST client can easily be 80% of the development effort in an integration, so the ability to generate it automatically has enormous value. Developers increasingly view OpenAPI docs as a hard requirement for a minimum viable product.

4 Likes
Highlighted
Tourist
4 0 9

Not only is it a gigantic waste of time to hand-write API documentation and consumers based on that documentation, but human error inevitably creeps in. I've just spent about six hours writing DTOs for Order and its related types. That should have been done in five seconds. I made some assumptions about scalar types and nullability, so I probably made some mistakes. There are mistakes in the documentation, too. For example, the field descriptions for line_items describe several fields that aren't in the example JSON. Which is correct, the JSON or the descriptions? I can't tell without testing. Auto-generating an OpenAPI spec would save you the trouble of maintaining the documentation.

4 Likes
Highlighted
New Member
1 0 0

Completely agree @TMIA. We personally faced this issue and figured out it is better to develop a tool. So we created a community free tool - API Shark - https://www.cloudvector.com/api-shark/. It allows to auto-generate OpenAPI Specs. Check it out.

0 Likes