Skip to content

allengrant/shopify_openapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Usage

TypeScript

const OpenAPIClientAxios = require('openapi-client-axios').default

const definition = 'https://github.com/allengrant/shopify_openapi/raw/master/shopify_openapi.yaml'
let api = new OpenAPIClientAxios({ definition })
api = await api.init()

Python

# Generate the Python Client
openapi-python-client generate \
  --url https://github.com/allengrant/shopify_openapi/raw/master/shopify_openapi.yaml
cd shopify-admin-api-client
from shopify_admin_api_client import Client

client = Client(base_url="https://example.myshopify.com")

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contributions to the OpenAPI descriptions

We don't currently accept pull requests that directly modify the description artifacts found in this repository. If you have feedback on the descriptions or have found a mismatch between the behavior that is described in this repo and the runtime behavior of the API, please open an issue.

Contributions to other files in the repository

We will gladly accept pull requests for contributions to other files in this repository.

Submitting a pull request

  1. Fork and clone the repository
  2. Create a new branch: git checkout -b my-branch-name
  3. Make your change
  4. Push to your fork and submit a pull request
  5. Pat your self on the back and wait for your pull request to be reviewed and merged.

Bugs

If you find a bug, open an issue. We're actively maintaining this. We understand that Shopify's documentation doesn't always line up exactly with its behavior. That's why this spec is so important. We're documenting how the API really works.

Resources

About

Shopify OpenAPI Spec v3

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published