Webapi Module
AbstractSchemaGenerator
This abstract base class provides core functionality for generating API schema documentation (like WSDL or REST schemas) in Magento 2. Developers woul...
Authorization\GuestUserContext
This class represents an anonymous/guest user context in Magento's Web API authorization system. Developers use this when processing API requests from...
Authorization\OauthUserContext
This class determines the user context for Web API requests authenticated via OAuth tokens. It validates OAuth access tokens from HTTP request headers...
Authorization\SoapUserContext
This class identifies and authenticates SOAP API users by extracting and validating bearer tokens from request headers. It determines the user ID and...
Authorization\TokenUserContext
This class determines the user context (user ID and type) for web API requests by validating Bearer tokens from the Authorization header. Developers u...
Cache\Type\Webapi
This class manages the Web Services Configuration cache type in Magento 2. Developers use it to cache API configuration data and generate unique cache...
Config
This class provides access to consolidated Web API configuration from all webapi.xml files across Magento modules. Developers use it to retrieve servi...
Config\ClassReflector
This class uses PHP reflection to analyze service classes and extract their API metadata, including method signatures, parameters, return types, and d...
Config\Converter
This class converts webapi.xml configuration files into a structured array format that Magento can use internally. Developers encounter this when defi...
Config\Reader
This class reads and parses Magento 2 Web API configuration files (webapi.xml) that define REST and SOAP API routes, resources, and parameters. It ext...
Config\SchemaLocator
This class provides the file paths to XSD schema files used for validating Web API configuration files (webapi.xml). Developers rarely interact with t...
Rest\Config
This class manages REST API route configuration in Magento 2. Developers use it to retrieve matching REST routes based on incoming HTTP requests, incl...
Rest\Swagger
This class generates Swagger 2.0 specification documentation for Magento's REST API endpoints. Developers use it to programmatically build API documen...
Rest\Swagger\Generator
This class generates Swagger/OpenAPI documentation for Magento 2's REST API endpoints. Developers use this to automatically create interactive API doc...
ServiceMetadata
This class manages Web API service metadata for Magento 2, providing configuration details about available REST/SOAP services including their methods,...
Soap\Config
This class manages SOAP Web API configuration in Magento 2, providing information about available SOAP operations, their corresponding service classes...
Soap\Fault
This class handles SOAP fault responses for Magento 2's Web API. It converts exceptions into properly formatted SOAP fault XML messages, including err...
Soap\Server
This class implements Magento 2's SOAP server functionality for handling web API requests via SOAP protocol. Developers would use this when setting up...
Soap\Wsdl
This class extends Laminas SOAP WSDL functionality to generate Magento-specific WSDL documents for web services. Developers use this when building SOA...
Soap\Wsdl\ComplexTypeStrategy
This class generates WSDL (Web Services Description Language) complex type definitions for Magento 2's SOAP API. It processes PHP classes and their pr...
Soap\Wsdl\Generator
This class generates WSDL (Web Services Description Language) documents for Magento 2's SOAP API. Developers use this when they need to provide SOAP w...
WebapiRoleLocator
This class retrieves the ACL (Access Control List) role ID for the current Web API user. Developers use this to determine what permissions and resourc...