Nordic APIs·2yIntroduction to TypeSpec
TypeSpec is an API description language that aims to differentiate itself from OpenAPI. It was created by Microsoft to meet the needs of a large and varied developer community. The language is lightweight, easy to integrate with OpenAPI, and allows API guidelines to be expressed in reusable code. However, it may not be suitable for those who prefer a code-first approach or graphical tools for API design.
Nordic APIs·2y10 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.
asayer·2yDocument your API with Swagger
Swagger simplifies API documentation by providing clear, interactive tools that enhance the API development process. It allows developers to define endpoints, parameters, and responses efficiently. Built on the OpenAPI Specification, Swagger supports multiple programming languages and frameworks, offering both online and local installation options. The tool's advanced features include code generation, testing, and customization, making it a powerful asset for creating comprehensive and user-friendly API documentation.
Nordic APIs·2y8 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.
Awesome Go·2yThe value of API-First design on side-projects
API-First design prioritizes the development of APIs before implementing other parts of a software system. It places the API at the center of the development process, facilitating the creation of a well-designed and consistent API that serves as the foundation for the entire application. By using tools like OpenAPI Specification, developers can generate backend and frontend code, ensuring better synchronization and saving time. This method leads to improved development speed, reduced errors, and better API documentation, making it a highly beneficial approach for side projects.
Trendyol Tech·2ySwagger 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.
Laravel News·2yAdd 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.
Nick Chapsas·2ySwagger is Gone in .NET 9! Replace It With This.
Swagger has been removed in .NET 9 and replaced with Microsoft's built-in OpenAPI functionalities. To adapt to this change, developers can use the 'app.mapOpenAPI' call for API documentation without a UI. Alternatively, they can integrate third-party tools such as Swashbuckle to restore the Swagger UI, or use Scaler, which offers a modern and customizable API documentation UI. Scaler provides various themes and integration options, including dark mode and authentication schemes, making it a versatile alternative.
Nordic APIs·2yAPI 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.
Laravel News·1yAutomated API documentation of Laravel API resources
API resources enhance the handling of data transformations for API responses in Laravel. Scramble is an automatic OpenAPI documentation generator that supports Laravel API resources without requiring PHPDoc annotations. With its latest update, it now fully supports API resource payload-building methods, ensuring accurate and up-to-date documentation.
Laravel News·2yAutomated 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.
.NET Blog·1yOpenAPI document generation in .NET 9
ASP.NET Core in .NET 9 introduces built-in support for OpenAPI document generation, simplifying the process of documenting API endpoints. This feature supports both Minimal APIs and controller-based applications, and allows for customization via attributes and extension methods. Developers can generate OpenAPI documents at both runtime and build time, integrate metadata for better documentation, and use transformers for further customization.
DEV·2yWriting type safe API clients in TypeScript
Learn how to write type safe API clients in TypeScript using openapi-typescript and axios. Generate the schema from an OpenAPI spec file, integrate it into your API layer, and make API calls using the generated client. Discover the benefits and caveats of this approach.
Planet Python·2yOn FastAPI
FastAPI is a Python web framework that builds on the strengths of Django and Flask while feeling more modern and adhering to certain opinionated principles. It has excellent documentation, includes Swagger UI and Redoc out-of-the-box, and heavily depends on Pydantic for data schemas and validation.
Nick Chapsas·2ySwagger is Going Away in .NET 9!
Swagger is being removed in .NET 9, but alternative packages are available. Microsoft is aiming to provide more flexibility and features with their own package. The decision has sparked a discussion on whether Microsoft should build these packages in-house or support external packages.
Baeldung·1yAutomated Testing for OpenAPI Endpoints Using CATS
Explores the use of CATS (Contract Auto Test Service) for automated testing of REST APIs with OpenAPI configurations. CATS generates and runs tests based on the API contract, simplifying the testing process and improving API reliability by identifying potential issues early. Key features include automatic test generation, HTML report creation, and integration with authorization requirements. The post provides a detailed guide on installing CATS, configuring tests, and analyzing test reports to address common API issues.
Changelog·2yOpenAPI & API Design with Jamie Tanna (Go Time #328)
This episode features Kris and Johnny with guest Jamie Tanna discussing OpenAPI, API design philosophies, versioning, and the challenges of open source maintenance. Key highlights include oapi-codegen moving to its own organization and creating a sustainable model, as well as technical insights like handling JSON fields in Go and the concept of APIs as infrastructure.
LogRocket·1yGenerating OpenAPI API clients for Angular
Generating OpenAPI API clients can streamline the development process for Angular applications, allowing developers to generate client modules automatically based on a standard API specification. This process saves time, reduces errors, and ensures consistent implementation. The tutorial covers using OpenAPI Generator CLI to create and integrate API clients into an Angular project, with detailed steps on setting up dependencies, generating code, and best practices for maintaining quality and manageability.
Just Java·2yHexagonal architecture with Spring Boot demo
A developer has created a sample project that incorporates Spring Boot, Hexagonal Architecture, Kafka, Testcontainers, OpenAPI, and additional technologies. This project is hosted on GitHub and is open for contributions to enhance its features.
