Rest API - API Documentation
You want to define a reusable error response in OpenAPI to use in multiple endpoints. Where should you define it and how do you reference it?
You want to define a reusable error response in OpenAPI to use in multiple endpoints. Where should you define it and how do you reference it?
hard📝 Application Q8 of 15
Step-by-Step Solution
Solution:
Step 1: Identify reusable components location
Reusable responses are defined undercomponents/responsesin OpenAPI.Step 2: Understand referencing syntax
References use$refwith the path#/components/responses/Name.Final Answer:
Define under components/responses and reference with $ref: '#/components/responses/ErrorResponse' -> Option BQuick Check:
Reusable responses live in components/responses [OK]
Quick Trick: Use components/responses for reusable error definitions [OK]
Common Mistakes:
MISTAKES- Defining reusable responses under paths
- Referencing with wrong $ref paths
- Placing reusable items in info or servers
Master "API Documentation" in Rest API
Want More Practice?
15+ quiz questions · All difficulty levels · Free
Free Signup - Practice All QuestionsMore Rest API Quizzes