October 2018 Summaries

API Metrics is a new product by ReadMe that provides comprehensive insights into API usage, enabling users to monitor who is using their API, how frequently, and with what success. This tool comprises two main components: the API Metrics Dashboard and Customer Facing Logs. The dashboard allows admins to filter API logs by criteria such as status code, endpoint, method, and project, offering a segmented overview of usage metrics, status codes, and detailed logs of API calls. These features help in identifying active and inactive users, frequently used endpoints, and potential issues before they arise. The Customer Facing Logs feature lets authenticated users view their API interaction history, aiding in troubleshooting and self-diagnosis. API Metrics is free for up to 10,000 logs per month, with subscription options available for higher usage, and is integrated into ReadMe after defining the API.

After years of feature additions leading to a cluttered dashboard, ReadMe undertook a reorganization to streamline its interface into four main sections, enhancing user experience and functionality. The refined dashboard now comprises the Project Dashboard, where users can manage team settings and view documentation metrics; APIs, which includes API configurations and the new API Metrics product; Documentation, for updating content and appearance in the Developer hub; and Users, which facilitates authentication for personalized user content. This new layout has been tested internally and is anticipated to improve usability for all users.

Automating API documentation is crucial for ensuring it remains accurate and user-friendly, as outdated documentation can frustrate users when it doesn't match the implementation. The blog, based on a talk from ReadMe's API Mixtape conference, emphasizes automating documentation through tools like Swagger/OAS specifications, which can be auto-generated based on code to remain current and accessible. Additionally, it highlights the importance of providing regular, use-case-focused documentation to guide users effectively, suggesting a hybrid approach where some documents are maintained within the codebase while others are edited externally. Personalization is also key, with tools like ReadMe allowing integration of API keys directly into the documentation to lower the entry barrier for users and creating personalized user experiences through automated logins. Overall, automating documentation not only keeps it up-to-date but also enhances user satisfaction by making it more interactive and accessible.