C1000-138 IBM API Connect v10.0.3 Solution Implementation

In IBM API Connect v10.0.3, rate limiting for APIs can be defined in two primary places: Plan and Catalog .

Plan : Rate limiting is typically defined at the Plan level. A Plan in API Connect specifies how an API or a group of APIs is exposed to consumers. It can include rate limits, quotas, and other restrictions. Defining rate limits at the plan level ensures that each application subscribed to the plan adheres to the specified API consumption limits, such as the number of API calls allowed within a given time period.

Catalog : The Catalog is another place where rate limits can be defined. A Catalog represents a collection of APIs and their configurations, including security and rate limiting policies. Rate limits defined at the Catalog level apply globally to all APIs and applications within that Catalog, providing an overarching control mechanism to enforce consumption limits across different APIs.

These two locations allow flexibility in controlling API usage, either by restricting usage per plan (at a more granular level) or globally across all APIs within a catalog.

References:

IBM API Connect v10.0.3 - Now Available

IBM API Connect Documentation

$ref Usage : The $ref keyword is used in OpenAPI (formerly Swagger) specifications to reference reusable components, such as schemas, parameters, and responses, defined elsewhere in the document or in external files.

Replacement Mechanism : When an API is published, the $ref is processed and replaced with the actual contents of the referenced file or component. This allows for modular and maintainable API definitions, where common elements can be defined once and reused across multiple APIs.

YAML and JSON : The $ref keyword can be used in both YAML and JSON files, which are common formats for defining OpenAPI specifications. It is not limited to YAML files.

Location Flexibility : $ref can be defined at various levels within the YAML or JSON file, not necessarily at the root level. It can be used within objects, arrays, and other structures as needed.

Gatewayscript : While Gatewayscript can include external files, it does not use the $ref keyword in the same way as OpenAPI specifications. Gatewayscript has its own mechanisms for including and referencing external scripts.

References :

IBM API Connect documentation on OpenAPI specifications and the use of $ref.

General principles of API design and modularization using OpenAPI.