Developer Tools

API Documentation Checker

by BEIKE YAN

Overview

Extract API contract details, check whether documentation covers the stated API contract, and compare API contract versions. Results are structured, evidence-based, and limited to explicitly provided information.

Tools

check_api_documentation_coverage

ChatGPT

Use this when the user provides an API contract and API documentation and wants to identify which explicitly stated endpoints, parameters, request fields, responses, and error definitions are covered, partially covered, or missing. Treat the provided contract as the fact source and return coverage findings with source evidence. Do not call APIs, test service availability, infer undocumented equivalence, evaluate architecture, or modify documentation.

compare_api_contract_versions

ChatGPT

Use this when the user provides two API contract versions and wants an exact comparison of endpoints, parameters, request fields, responses, and error definitions. Return added, removed, modified, and unchanged items with source evidence. Match items by explicit identifiers only and do not infer renames. Do not call APIs, evaluate architecture, determine compatibility, or modify either contract.

extract_api_contract

ChatGPT

Use this when the user wants to extract explicitly stated API endpoints, parameters, request fields, responses, and error definitions from provided API materials. It accepts user-provided API specifications, OpenAPI fragments, interface descriptions, or response examples and returns a structured API contract with source evidence. Do not call APIs, test service availability, infer undocumented behavior, evaluate architecture, or modify source material.

Example Prompts

Click any prompt to copy it.

Links

Documentation ↗Privacy Policy ↗

App Stats

Tools

Prompts

ChatGPT

Platforms