elisei/commerce-webapi

Source code for Adobe Commerce Web APIs developer documentation

Adobe Commerce Developer Documentation

Welcome! This site contains the latest Adobe Commerce and Magento Open Source developer documentation for ongoing releases of both products. For additional information, see our Contribution Guide.

Contributors

Our goal is to provide the Adobe Commerce and Magento Open Source communities with comprehensive and quality technical documentation. We believe that to accomplish that goal we need experts from the community to share their knowledge with us and each other. We are thankful to all of our contributors for improving the documentation.

Local development

This is a Gatsby project that uses the Adobe I/O Theme. Ensure that your local environment matches the prerequisites described in the Adobe I/O Theme README.

To build the site locally:

1. Clone this repo.

2. Install project dependencies.

   yarn install

3. Launch the project in development mode.

   yarn dev

Resources

See the following resources to learn more about using the theme:

• Arranging content structure
• Linking to pages
• Using assets
• Configuring global navigation
• Configuring side navigation
• Using content blocks
• Writing enhanced Markdown
• Deploying the site (Adobe employees only)

If you have questions, open an issue and ask us. We look forward to hearing from you!

GraphQL API reference generator

The GraphQL API reference is generated using an open-source tool SpectaQL. The data required for the generator is located at the spectaql directory:

• adobe-theme: custom theme.
• config.yml: configuration file.
• schema.json: the GraphQL schema extracted from the Adobe Commerce (B2B) instance.

The resulted GraphQL API reference lives in the static/graphql-api/ directory. It is embedded into the /graphql/reference page using the frameSrc feature on the DevSite.

To rebuild the GraphQL API reference after any updates, run:

yarn build:spectaql

To run SpectaQL in the development mode:

yarn dev:spectaql

How to get the schema

The website in the public directory was generated for the Adobe Commerce with B2B instance from GraphQL Schema 'schema.json'. The schema was retrieved using the apollo-cli tool:

npx apollo-cli download-schema $ENDPOINT_URL --output schema.json

where $ENDPOINT_URL is a placeholder for a URL's endpoint.

For more information about SpectaQL, refer to https://github.com/anvilco/spectaql.