Reflect interceptor details in the generated OAS

[lnash94]

Summary

In the context of a REST API, an interceptor refers to a mechanism or component that allows you to intercept and manipulate HTTP requests and responses at various points in their lifecycle. Interceptors provide a way to add cross-cutting concerns, such as authentication, logging, error handling, or custom headers, to the processing flow of an API.

Goals

By incorporating interceptor details into the OAS, we aim to enhance the clarity, consistency, and automation capabilities of our API documentation. This approach ensures that developers and other stakeholders have a comprehensive understanding of how interceptors influence API behaviour and how they can be configured.

Interceptors are designed for both request and response flows. There are just service objects which will be executed in a configured order to intercept request and response. These interceptor services can only have either a resource method or a remote method depending on the interceptor type. FLoowing are the main areas we focused for the mapping interceptor details into OAS.

• Request interceptor
• Response interceptor
• Request error interceptor and response error interceptor
• Engaging interceptors
• Data binding

Non-Goals

Motivation

Success Metrics

Description

Alternatives

Testing

Risks and Assumptions

Dependencies