Best of OpenAPI — September 2024

1. 1
   Article

   Nordic APIs·2y

   10 Best API Documentation Tools for 2024

   API documentation is a pivotal aspect of both user experience (UX) and developer experience (DX). The post lists ten top API documentation tools for 2024, highlighting features like interactive documentation, AI-driven generation, and support for multiple programming languages. Notable mentions include Apiary, Slate, SwaggerHub, Knowl.ai, and Gitbook, each catering to different needs such as Markdown support, collaboration, and comprehensive API management. The right tool can significantly enhance API usability and developer productivity.

   136

   1
2. 2
   Article

   Trendyol Tech·2y

   Swagger Annotation Checker for NestJS Projects

   Learn about the nest-swagger-checker package developed by Semih from Trendyol Tech to standardize Swagger UI in NestJS projects. The package checks Swagger-related decorators and ensures consistency in API documentation. Configurable to suit different project needs, it simplifies maintaining documentation standards across teams. The post also introduces an associated eslint plugin for real-time code checking.

   78
3. 3
   Article

   Hacker News·2y

   Analyzing the OpenAPI Tooling Ecosystem

   The post dives into the OpenAPI Specification (OAS) ecosystem, analyzing how various tools interact with OAS 3.1 and the upcoming versions 3.2 and 4.0, codenamed 'Moonwalk'. It details an idealized architecture that groups tools into parsing libraries, OAD tools, and API tools, and highlights the challenges in categorizing these tools. The post also introduces color-coded diagrams to visualize these components and discusses future steps for aligning the spec with tooling requirements.

   11