January 2017 Summaries

Faced with the need to efficiently run a cron job to fetch users nearing the end of their trials and insert them into a customer database, the author explores the use of AWS Lambda as a cost-effective and scalable solution. AWS Lambda's pay-per-use model and cloud environment make it a suitable alternative to traditional server-based implementations, which can be costly and inefficient for tasks that run briefly and infrequently. By utilizing the Serverless framework and AWS ScheduledEvents, the author demonstrates how to set up and deploy a cloud-based function that automates this process, allowing for easy scheduling and execution without the overhead of managing server infrastructure. This approach highlights the advantages of serverless computing, particularly for microservices that require minimal setup and operational costs, emphasizing its potential for broader applications in the future.

The text discusses the importance of having effective quick start guides in API documentation to facilitate experiential learning, which is favored by developers who prefer learning-by-doing. These guides aim to demonstrate the simplest API functions with minimal steps, making them accessible and appealing to developers. Different approaches to creating quick start guides include using language-agnostic commands like curl or Postman to allow immediate testing without setup, and providing SDKs or sample projects to shorten the time to first “hello world” (TTFHW). The text highlights examples from companies like GitHub, Mailgun, Square, Clearbit, Dropbox, Parse, and Auth0, illustrating how each effectively engages developers with their APIs. These guides not only lower the barrier to entry for developers but also serve as essential marketing tools by demonstrating the API's utility and ease of use, thus encouraging further exploration and integration.

Effective API documentation is crucial for the usability of an API, as it acts as the bridge between the API itself and the developers who utilize it. Comprehensive documentation should include essential elements such as an overview, authentication details, and error handling, along with code snippets to demonstrate real-world application. The design should facilitate easy navigation through dynamic pages, using elements like anchor text and a two-pane view for simultaneous access to explanations and code. To enhance usability, features like support buttons and options for readers to suggest edits can improve the documentation's quality and responsiveness. Additionally, providing resources such as quick start guides, tutorials, and API explorers can aid in developer education and onboarding. Tools like analytics and support software are also recommended to monitor API usage and manage developer inquiries effectively. The checklist aims to cater to both solo developers and large teams, suggesting an incremental approach to building documentation, starting with the essentials and expanding over time.

ReadMe faced challenges with their SSL setup, primarily due to cost and complexity, as enabling SSL required purchasing certificates and setting up Heroku apps, leading to high expenses and technical hurdles for users. To address these issues, ReadMe explored Let's Encrypt, a free certificate authority that issues short-lived certificates with an API for automatic renewals, encouraging automation and simplifying the process. Testing involved using Certbot on EC2 and employing OpenResty, a dynamic web platform based on NGINX and LuaJIT, to dynamically serve and generate SSL certificates for arbitrary domains. This new system significantly simplifies CNAME DNS setup and is being phased into production, with plans to save thousands of dollars monthly. ReadMe also commits to donating to Let's Encrypt for every certificate generated, encouraging other companies to support the initiative.