Best of OpenAPIAugust 2024

  1. 1
    Article
    Avatar of nordicapisNordic APIs·2y

    8 Tools To Automatically Generate API Documentation

    API documentation is crucial for communication between developers and end users. This post highlights top tools for automatically generating API documentation, including Swagger, Postman, DreamFactory, Apiary, Read the Docs, Theneo, Redocly, and ReadMe. Each tool offers unique features, integration options, and levels of automation, which can be selected based on specific API requirements and team workflows.

  2. 2
    Article
    Avatar of lnLaravel News·2y

    Add Swagger UI to Your Laravel Application

    The Laravel Swagger UI package allows developers to easily integrate and display their project's Swagger (OpenAPI v3) file within a Laravel application. By placing the OpenAPI file in the specified directory and navigating to the correct URL, users can access the Swagger UI. The package also supports OAuth2 configuration and custom authorization logic for enhanced security.

  3. 3
    Article
    Avatar of nordicapisNordic APIs·2y

    API Design in the Post-OpenAPI Era

    New description languages and frameworks are influencing API design, shifting from traditional OpenAPI Specification towards tools like TypeSpec. The aim is to reduce errors and improve the API development experience. The Platform Summit will feature experts discussing these trends, highlighting tools that support API-first strategies and domain-specific languages for creating consistent API products. The role of OpenAPI is evolving into automatically generated artifacts rather than manually edited files.

  4. 4
    Article
    Avatar of lnLaravel News·2y

    Automated API documentation generation for Laravel with static code analysis using Scramble

    Maintaining API documentation in Laravel can be time-consuming and error-prone when done manually with PHPDoc annotations or OpenAPI spec files. Instead, Scramble offers a streamlined solution using static code analysis, ensuring documentation remains accurate and up-to-date with code changes. Scramble automatically documents request parameters, successful and error responses, and keeps everything in sync, alleviating the effort required by developers.