As Shopify apps become more complex, keeping API documentation accurate can become a challenge, especially when APIs evolve alongside the application.
We’re looking into CLI tools for API documentation and wondering how other Shopify developers are handling this.
Our ideal workflow would allow us to:
- Generate or update API documentation from OpenAPI specifications
- Keep documentation synchronized with API changes
- Run documentation generation from the command line
- Integrate documentation workflows into CI/CD
- Avoid manually updating documentation after every API change
For example, we’re considering a workflow where API changes are committed to Git, then a CLI tool automatically validates the specification and generates updated documentation as part of the development pipeline.
This seems particularly useful for Shopify apps that expose their own APIs or integrate with external services.
I’m curious how other Shopify developers approach this:
- Are you using a CLI tool to generate API documentation?
- Do you generate documentation automatically from OpenAPI?
- Is API documentation part of your CI/CD pipeline?
- Which CLI tools have worked well for your team?
I’d be interested to hear what workflows you’re using to keep API documentation up to date as your Shopify apps evolve.