📄️ Authentication
Unlock the Benefits of an Authentication SDK to Simplify Complexity and Offer Flexibility to Developers. Streamline Authentication with SDKs Designed for HTTP Basic, API Access Token and OAuth.
📄️ Endpoints into Methods
Learn how to organize endpoints into methods in order to create an efficient SDK. Discover best practices when setting headers and constructing URLs with query parameters, and find out how to reduce the number of classes developers need to initialize.
📄️ Models & Serialization
Unlock the power of models and serialization for easier access to data in APIs. Create objects without referencing API documentation and add data validation.
📄️ Logging
Customize your SDK logging with log4j & SLF4J. Get tips to maximize logging capability while controlling data in dev & prod environments.
📄️ Persistent connection
HTTP Keep-Alive allows developers to send multiple requests on a single TCP connection, saving network resources and reducing latency. Use the Keep-Alive header to customize timeouts and maximum number of requests for each TCP connection.
📄️ Timeouts and Retries
Need to handle short-term API disruptions in your SDK? Consider exponential backoff with retry – a practice that allows APIs to recover from errors by increasing the wait time between retries. You can also add a circuit breaker function.
📄️ Managing metadata
Managing metadata in an API helps developers track adoption and troubleshoot issues efficiently. Custom user-agent headers can be used to identify the SDK version, while custom rate limit details can be captured
📄️ Optimize error message
Error messages are more than just a 400 Bad Request. Learn how to optimize your API error messages and create granular exception classes for better developer experience.
📄️ Distribution
Make sure your software development kits (SDKs) are accessible to developers by publishing them to popular package management platforms for each language. Include a changelog with each release and use semantic versioning.