APIGEE-API-ENGINEER practice question 5 of 25

Which Apigee product feature can be used to host and version your API documentation'?

Full set: 126 questions
Answer options
A: Edge
B: API BaaS
C: Insights
D: Apigee-127
E: SmartDocs Correct answer
Correct Answer:
E. SmartDocs
Explanation

SmartDocs is the specific Apigee feature designed to generate, host, and manage interactive API documentation. It uses an OpenAPI Specification (formerly Swagger) to create a reference document that is hosted on an Apigee developer portal. This documentation is interactive, allowing developers to make live API calls directly from the documentation pages. SmartDocs also supports versioning by allowing you to import different versions of your OpenAPI Specification, enabling you to maintain documentation for multiple revisions of your API.

Why Incorrect

A. Edge: Apigee Edge (now Apigee X/hybrid) is the core API management platform itself, not the specific feature for hosting documentation. SmartDocs is a component within the platform's developer portal.
B. API BaaS: API BaaS was a Backend-as-a-Service feature for data storage and user management. It has been deprecated and was not used for API documentation.
C. Insights: Apigee Insights was a predictive analytics service for API traffic data. It has been deprecated and is unrelated to documentation hosting.
D. Apigee-127: Apigee-127 was an open-source command-line tool and framework for designing and building APIs with Node.js, not for hosting the final documentation.

References

1. Google Cloud, Apigee Documentation, "Document your APIs": "Apigee supports the generation of API documentation from an OpenAPI Specification. The generated documentation, called SmartDocs, is interactive..." This source directly identifies SmartDocs as the feature for generating documentation from an OpenAPI spec.

2. Google Cloud, Apigee Documentation, "About SmartDocs": "SmartDocs lets you document your APIs on the Apigee developer portal in a way that makes the API documentation fully interactive. With SmartDocs, users of your APIs can... Read about the API... Send a live request to the API..." This confirms the interactive nature and hosting location of SmartDocs.

3. Google Cloud, Apigee Documentation, "API BaaS": "API BaaS is no longer available for purchase... Apigee API BaaS provided a way to get a backend for your app with data storage and management..." This confirms the purpose and deprecated status of API BaaS.

4. Google Cloud, Apigee Documentation, "Apigee-127": "Apigee-127 is a toolkit that helps you design, build, and deploy APIs with Node.js." This reference clarifies that Apigee-127 is a development tool, not a documentation hosting feature.

Scroll to Top