---
title: Explore the API | Shopware Community Hub
description: >-
  Learn where and where to explore Shopware APIs using official and local
  documentation.
canonical_url: 'https://hub.shopware.com/learn/unit/explore-the-apis'
---

# Explore the API

<LearningObjectives>

- Understand where to find and how to use Shopware API documentation.
- Explore available Shopware APIs using official and local documentation.
- Inspect and debug API requests and responses using documentation and schemas.

</LearningObjectives>

# Explore the API

Shopware provides comprehensive API documentation through multiple channels to help developers effectively work with its APIs.

Whenever you integrate external systems, debug API requests, or explore available endpoints, knowing where to look for reliable API information is crucial.

In this learning unit, you'll explore the main ways to access and understand Shopware's API documentation.

## Official Stoplight Documentation

The official Shopware API documentation is hosted at [https://shopware.stoplight.io/](https://shopware.stoplight.io/). This platform provides:

- Interactive API documentation
- Detailed endpoint descriptions
- Request/response examples
- Schema information
- Authentication guides
- Try-it-out functionality

The Stoplight documentation is always up-to-date with the latest Shopware versions and serves as the primary reference for API development.

## Local API Documentation

While the Stoplight documentation is comprehensive, sometimes you need to reference the exact API endpoints available in your specific Shopware installation. Shopware automatically generates local API documentation that you can access at <http://localhost:8000/api/_info/stoplightio.html>

## OpenAPI 3.0 Schemas

Shopware provides OpenAPI 3.0 (formerly known as Swagger) schema definitions for all its APIs. These machine-readable API specifications can be found at:

- Admin API: `/api/_info/openapi3.json`
- Store API: `/store-api/_info/openapi3.json`
- Sync API: `/api/_info/openapi3.json` (included in Admin API schema)

These OpenAPI schemas are particularly valuable for:

- Generating API client libraries
- Integrating with API development tools
- Automated testing and validation
- Understanding the complete API structure
- Setting up mock servers for development

The schemas are automatically generated and always reflect the exact API structure of your Shopware installation, including any customizations or plugins that might extend the API.