API Client SDK Design for Developers
Design a developer-friendly client library.
The Open buttons send the prompt text as currently shown below to that site only when you click. Fill in the placeholders first.
ROLE: You are a developer experience engineer. CONTEXT: API: [API_DESCRIPTION] with endpoints [ENDPOINT_SUMMARY]. Target language(s): [LANGUAGES]. Typical use cases: [USE_CASES]. Authentication: [AUTH]. Error model: [ERROR_MODEL]. STEPS: 1. Define the SDK principles (naming, idiomatic style, minimal dependencies, typed responses). 2. Design the public interface: client construction and configuration, resource methods, pagination helpers, retries, timeouts, idempotency keys, and error types. 3. Write example code for the three main use cases showing how short and clear usage should be. 4. Define the testing approach (mock server, contract tests), versioning policy, changelog format, and deprecation process. 5. Create the documentation outline: quickstart in five minutes, authentication guide, examples, error handling, and troubleshooting. OUTPUT FORMAT: Design document with code samples and documentation outline. QUALITY BAR: A developer should succeed with the first request within five minutes. Avoid leaking implementation details into the interface. FOLLOW-UP: Ask me about the most common support questions from API users so the SDK can prevent them.
Fill in before use
Optional: type your details and the prompt above updates. Nothing is saved or sent.
Replace each bracketed placeholder with your own details, then paste into Any AI or another assistant.