1 views collected around this technical thread.
This guide explains why Spring Boot 3 is incompatible with Swagger 2, shows how to downgrade or replace dependencies, updates servlet imports, adjusts Maven and application settings, and provides a complete Swagger configuration to get the API docs running again.
This article explains how to leverage smart-doc to automatically generate JMeter performance testing scripts from API code, import them into JMeter, set up Prometheus monitoring and Grafana dashboards, and highlights the automation benefits for backend development and operations workflows.
pdoc is a lightweight Python command‑line tool that automatically extracts docstrings to produce clean HTML API documentation, offering features such as module and package generation, custom templates, markdown export, and a built‑in preview server for rapid documentation workflows.
NetEase Cloud Music built a code‑centric, automated API documentation platform that extracts Javadoc annotations, tracks code relationships in a graph database, processes incremental GitLab commits, and generates synchronized documentation with change diffs and notifications, dramatically reducing manual effort and ensuring consistency.
This article explains what Swagger is, why it is useful for RESTful API documentation, and provides a step‑by‑step guide for integrating Swagger 3.0 with Spring Boot 2.7.6, handling version conflicts, customizing Docket settings, securing the UI, and applying advanced annotations to enrich the generated documentation.
This tutorial explains what Swagger is, why it is useful for RESTful API documentation, and provides step‑by‑step instructions for integrating Swagger 3.0 into a Spring Boot 2.7.6 project, including Maven dependencies, configuration classes, handling startup errors, customizing the UI, security settings, and annotation usage.
This article presents a series of concrete, experience‑driven recommendations—such as embedding documentation links in code comments, publishing source to private repositories, defining constants in parameter classes, handling Map payloads with typed objects, simplifying dependencies, and logging raw request/response data—to enhance the maintainability of backend interfaces throughout the software lifecycle.
This article shares a series of practical, experience‑based recommendations for enhancing the maintainability of software interfaces—including documentation links, constant definitions, Map usage, dependency simplification, logging practices, and Java code examples—aimed at reducing maintenance costs and improving developer efficiency.
Learn how to install and configure the Apifox Helper plugin in IntelliJ IDEA to automatically generate, sync, and debug Java Spring API documentation, offering a zero‑intrusion alternative to Swagger with built‑in mock and testing features.
This guide shows how to eliminate manual Controller code by automatically exposing CommandService and QueryService as web endpoints, integrating with Swagger for dynamic API documentation, and explains the underlying unified controller architecture and extension points.
This article explains what API documentation is, why it is essential for backend development, outlines standard interface specifications, and discusses efficient ways to produce and maintain API docs, including the use of modern tooling to automate generation and testing.
In Chinese internet firms, front‑end development has grown into large specialized teams, and DeWu’s API‑documentation‑driven development model—presented by former Alibaba leader Zhu Junbiao and explained by Chen Ziyu—demonstrates how an API‑driven workflow on the Mooncake platform resolves collaboration bottlenecks and boosts development efficiency.
This article compares Java Swagger libraries SpringFox and SpringDoc, explains when to choose each, and demonstrates how to integrate SpringDoc with Knife4j for enhanced API documentation, JSON validation, data folding, and a microservice aggregation solution.
This guide shows how to install Go‑Swagger, annotate Go code with Swagger comments, generate a swagger.json file, serve it via Nginx, and configure Yapi to automatically import the spec, creating a seamless, always‑up‑to‑date API documentation pipeline for front‑end and back‑end teams.
After SpringFox became outdated and incompatible with Spring Boot 2.6, this article introduces SpringDoc as a modern OpenAPI 3‑based alternative, explains its advantages, shows how to integrate it, migrate annotations, configure security, and provides sample code and screenshots for a seamless transition.
This article explains why and how to aggregate Swagger API documentation across multiple Spring Cloud microservices by creating a reusable swagger‑starter, configuring each service, and implementing a GatewaySwaggerResourcesProvider to expose a unified documentation entry point.
This article introduces think-swagger-ui-vuele, a custom Swagger UI built on think‑vuele that simplifies API documentation by parsing Swagger JSON, offers fast loading for large APIs, supports mock data, customizable request headers, and provides both npm and Maven integration with usage instructions and code examples.
This article introduces Knife4j, a lightweight Java MVC Swagger enhancement, explains its core features and UI improvements, and provides a step‑by‑step guide with Maven dependencies, configuration classes, model definitions, and controller code to quickly set up interactive API documentation in a Spring Boot project.
Learn how to set up the enterprise‑grade Torna API documentation platform, integrate it with Swagger, and run it on Windows, Linux, or Docker, covering project structure, installation steps, configuration, and advanced features like permission control, mock data, and interface testing.
This tutorial shows how to replace Swagger with smart-doc, a zero‑annotation API documentation tool for SpringBoot that generates HTML docs and Postman collections, covering Maven plugin setup, configuration files, custom tags, error‑code mapping, request‑header definitions, and step‑by‑step usage examples.