Stripe's OpenAPI Specification

This repository contains an OpenAPI specification for Stripe's API. Both JSON and YAML formats are included and available in the spec directory.

Fixtures

The repository also contains a set of test fixtures for API resources which can be used to create higher quality mocked responses. These are also located in the spec directory.

All API resources in the specification are tagged with a vendor-prefix attribute called x-resourceId. The value of the attribute is an identifier that can be used to find the associated fixture in one of the fixture data files.

So for example:

# spec.yaml
---
definitions:
  invoice_line_item:
    ...
    x-resourceId: invoice_line_item

# fixtures.yaml
---
invoice_line_item:
  ...

Updates

Please make updates to the script included in bin to help maintain consistency and commit cleanliness (search JIRA for full instructions):

bin/update

Development

Run the test suite:

make