An API is a language, and like any language, it requires consistent grammar to be understood. In developer documentation, an inconsistently formatted endpoint—using camelCase in one place and kebab-case in another—signals a lack of technical maturity and can lead to implementation errors. The API Endpoint Governance rule is a high-fidelity "Technical Sieve" that ensures your documented RESTful interfaces follow industry-standard conventions with 100% precision.
This rule performs a forensic audit of every URI mentioned in your document. It enforces "RESTful Purity" by identifying "RPC-Style Leaks." In a true RESTful API, paths should represent Nouns (Resources), not Verbs (Actions). If the validator detects a verb in the path (e.g., /get-user), it flags it as a "Hard Fail," prompting the writer to use a proper resource-based path (e.g., /users). This ensures that your documentation reflects a professional, architecture-conscious brand that developers will respect.
"URI Casing Integrity" is another critical layer. Modern web standards favor kebab-case (e.g., /user-profiles) for URL segments because it is more readable and avoids the case-sensitivity issues of camelCase or snake_case. Our auditor identifies these "Casing Violations" in real-time, ensuring that your endpoints are technically sound and optimized for the modern web. It also enforces "Pluralization Standards," requiring that collection resources (e.g., /users) use the plural form, which is a foundational rule of RESTful design.
The rule also manages "Method-Text Synchronization." A common documentation error is describing a "deletion" but documenting the HTTP method as POST instead of DELETE. TaskVerified identifies these "Sync Failures" by analyzing the surrounding prose and comparing it to the documented method. This acts as a "Logic Firewall," ensuring that your instructions and your technical specifications are in perfect alignment. It also identifies "Destructive GET Mismatch," flagging any GET endpoint that includes destructive keywords like 'delete' or 'remove'.
For API platform managers, this rule is a "Version Drift Detector." It identifies the API version mentioned in the paths (e.g., /v1/) and ensures that it remains consistent throughout the entire document. If a writer accidentally mixes /v1/ and /v2/ endpoints in the same guide, the system flags the "Version Drift," preventing implementation confusion and build failures. This level of automated governance is essential for maintaining a high-authority, trustworthy developer hub.
API documentation is the interface of your product. The API Endpoint Governance rule ensures that your "interface" is as professional, consistent, and architecturally sound as the code itself, protecting your brand's reputation for technical excellence.