"In a previous post on agent experience (AX), we wrote that “Artificial intelligence tools are bad at inferring context or reading between the lines,” and that “content designed for consumption by AI should look less like a blog post and more like a legal contract. Great agent experience is all about being as clear and predictable as possible.”
Where possible, we need to eliminate assumptions that only make sense to human readers. LLMs aren’t as forgiving of undocumented constraints, inconsistencies, or vague descriptions as a human reader might be. If you’re struggling with that, we can lean on AI tools — it makes sense that AI would know what AI likes, right? — for identifying some of these gaps.
When we covered AI assistants for API developers, for example, we identified LintGPT as a useful tool for its ability to automate the creation of an API style guide, enforce specification standards, and even catch breaking changes before deployment.
API specifications are no longer just documentation. They’re living contracts with machines, which increasingly have the power to read and interact with said contracts. Improving clarity, consistency, and precision might create a few initial headaches, but it opens the door to smarter tooling, faster iteration, and APIs taking pride of place in an increasingly AI-driven ecosystem."
https://nordicapis.com/how-llms-are-changing-the-way-we-build-api-specifications/
#AI #GenerativeAI #LLMs #APIs #APIDesign #APISpecifications