Tagged articles
84 articles
Page 1 of 1
Advanced AI Application Practice
Advanced AI Application Practice
Mar 22, 2026 · Backend Development

How to Auto‑Generate Test API Docs with Trae Skill in Seconds (Step‑by‑Step Guide)

The article explains why manual API documentation drains testers' time, then demonstrates how Trae Skill’s AI‑driven, customizable rules can generate accurate, real‑time interface docs in about ten seconds, complete with examples, curl commands, and reusable configurations.

AI GenerationAPI documentationSoftware Testing
0 likes · 11 min read
How to Auto‑Generate Test API Docs with Trae Skill in Seconds (Step‑by‑Step Guide)
ShiZhen AI
ShiZhen AI
Mar 14, 2026 · Artificial Intelligence

How Context Hub Lets AI Coding Assistants Remember Past Pitfalls

Context Hub, an open‑source tool from Andrew Ng's team, automates real‑time API documentation retrieval and adds persistent annotations and community feedback, enabling AI coding assistants to avoid outdated calls, remember previous mistakes, and continuously improve their knowledge base.

AI programming assistantAPI documentationCLI tool
0 likes · 10 min read
How Context Hub Lets AI Coding Assistants Remember Past Pitfalls
Architect's Tech Stack
Architect's Tech Stack
Oct 20, 2025 · Backend Development

Master SpringDoc: Auto‑Generate OpenAPI Docs in Spring Boot with Zero Configuration

This guide explains how to integrate SpringDoc into a Spring Boot project to automatically generate OpenAPI 3 documentation, compares it with Swagger, shows minimal configuration steps, annotation usage, grouping techniques, and necessary adjustments for custom WebMvcConfigurer and Spring Security setups.

API documentationBackend DevelopmentOpenAPI
0 likes · 14 min read
Master SpringDoc: Auto‑Generate OpenAPI Docs in Spring Boot with Zero Configuration
Dunmao Tech Hub
Dunmao Tech Hub
Oct 11, 2025 · Backend Development

Quickly Add Swagger UI to Spring Boot 3.5.6 Using springdoc 2.7.0

This guide shows how to integrate springdoc‑openapi 2.7.0 with Spring Boot 3.5.6 to generate an online Swagger UI, covering Maven dependencies, configuration class, annotation usage, response wrapper, version compatibility notes, and the URL to access the generated documentation.

API documentationJavaOpenAPI
0 likes · 9 min read
Quickly Add Swagger UI to Spring Boot 3.5.6 Using springdoc 2.7.0
Spring Full-Stack Practical Cases
Spring Full-Stack Practical Cases
Oct 3, 2025 · Backend Development

Generate Spring Boot API Docs Instantly with Smart-Doc – A Complete Guide

This article introduces the Smart-Doc tool for Spring Boot, explains why API documentation is essential, compares common documentation solutions, and provides step‑by‑step instructions—including Maven plugin configuration, JSON settings, command‑line generation of HTML, Markdown, Word, Postman and OpenAPI formats, as well as package exclusion and additional options.

API documentationJavaMaven Plugin
0 likes · 10 min read
Generate Spring Boot API Docs Instantly with Smart-Doc – A Complete Guide
Architect's Tech Stack
Architect's Tech Stack
Sep 23, 2025 · Backend Development

Master SpringDoc: Minimal OpenAPI 3 Setup for Spring Boot

This tutorial walks through integrating SpringDoc into a Spring Boot project, covering why it replaces SpringFox, how to configure it with minimal settings, add API annotations, set up grouped documentation, and handle static resources and Spring Security for full Swagger UI access.

API documentationJavaOpenAPI
0 likes · 15 min read
Master SpringDoc: Minimal OpenAPI 3 Setup for Spring Boot
Ray's Galactic Tech
Ray's Galactic Tech
Sep 22, 2025 · Backend Development

Integrating Knife4j with OpenAPI 3 in Spring Boot 3.x – Step‑by‑Step Guide

This tutorial walks through adding the required Maven dependencies, configuring application.yml, creating SwaggerConfig, implementing sample controllers, accessing the enhanced Knife4j UI and Swagger UI, troubleshooting common issues, and comparing SpringDoc OpenAPI with Knife4j OpenAPI3 to help developers choose the right solution for Spring Boot 3.x projects.

API documentationJavaKnife4j
0 likes · 10 min read
Integrating Knife4j with OpenAPI 3 in Spring Boot 3.x – Step‑by‑Step Guide
Ray's Galactic Tech
Ray's Galactic Tech
Sep 21, 2025 · Backend Development

How to Quickly Integrate SpringDoc OpenAPI into Spring Boot for Swagger Docs

This guide walks you through adding the appropriate SpringDoc OpenAPI dependencies for Spring Boot 2.x or 3.x, configuring the library, creating sample controllers with OpenAPI annotations, customizing documentation metadata, and using advanced features like API grouping, hidden endpoints, and offline generation.

API documentationOpenAPISpringBoot
0 likes · 6 min read
How to Quickly Integrate SpringDoc OpenAPI into Spring Boot for Swagger Docs
Java Web Project
Java Web Project
Sep 13, 2025 · Backend Development

How to Quickly Integrate SpringDoc for OpenAPI Docs in Spring Boot

This article walks through why SpringDoc replaces SpringFox, shows step‑by‑step minimal configuration, dependency setup, controller annotations, API grouping (both programmatic and declarative), and necessary adjustments for WebMvcConfigurer and Spring Security to generate OpenAPI 3 documentation in a Spring Boot project.

API documentationConfigurationJava
0 likes · 15 min read
How to Quickly Integrate SpringDoc for OpenAPI Docs in Spring Boot
Java Architect Essentials
Java Architect Essentials
Sep 11, 2025 · Backend Development

Master SpringDoc: Zero‑Config API Docs for Spring Boot 2.6+

SpringDoc is a Spring Boot library that automatically generates OpenAPI 3 compliant API documentation, replacing the outdated SpringFox; this guide explains its advantages, minimal configuration steps, grouping techniques, and integration with Swagger UI for seamless API documentation in modern Spring applications.

API documentationBackendOpenAPI
0 likes · 15 min read
Master SpringDoc: Zero‑Config API Docs for Spring Boot 2.6+
Java Architect Essentials
Java Architect Essentials
Sep 11, 2025 · Backend Development

Mastering SpringDoc: Quick Setup and Advanced Grouping in Spring Boot

SpringDoc is a Spring Boot library that automatically generates OpenAPI 3 compliant API documentation, offering seamless integration with Swagger UI; this guide explains its advantages over SpringFox, walks through minimal configuration, grouping strategies, and handling of security and resource handling for robust API documentation.

API documentationBackend DevelopmentOpenAPI
0 likes · 14 min read
Mastering SpringDoc: Quick Setup and Advanced Grouping in Spring Boot
macrozheng
macrozheng
Aug 14, 2025 · Backend Development

Master SpringDoc: The Modern Swagger Alternative for Spring Boot 3

This guide introduces SpringDoc as a fully supported Swagger replacement for Spring Boot 3, covering its features, integration steps, configuration examples, comparison with SpringFox, usage with Spring Security, testing procedures, and links to the source repositories.

API documentationSpringDocSwagger
0 likes · 11 min read
Master SpringDoc: The Modern Swagger Alternative for Spring Boot 3
JakartaEE China Community
JakartaEE China Community
Jul 22, 2025 · Backend Development

Understanding MicroProfile OpenAPI Specification 3.0

This article explains the MicroProfile OpenAPI 3.0 specification, covering its architecture, configuration options, core properties, annotation usage, server definitions, programming model, model readers, filters, processing rules, endpoint behavior, and release notes for both 3.0 and earlier versions.

API documentationConfigurationJAX-RS
0 likes · 29 min read
Understanding MicroProfile OpenAPI Specification 3.0
Code Wrench
Code Wrench
Jul 8, 2025 · Backend Development

Automate Go gRPC API Docs in 3 Steps: Swagger Integration & Live Debugging

Learn how to eliminate manual API documentation in Go gRPC projects by automatically generating Swagger docs from Proto annotations, syncing with code changes, and enabling interactive testing, using tools like Buf, grpc-gateway, and Swagger UI in a concise three‑step workflow.

API documentationAutomationSwagger
0 likes · 5 min read
Automate Go gRPC API Docs in 3 Steps: Swagger Integration & Live Debugging
Java Captain
Java Captain
Jun 8, 2025 · Backend Development

How to Fix Spring Boot 3 and Swagger 2 Compatibility Issues

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.

API documentationCompatibilityConfiguration
0 likes · 4 min read
How to Fix Spring Boot 3 and Swagger 2 Compatibility Issues
37 Interactive Technology Team
37 Interactive Technology Team
Feb 13, 2025 · Backend Development

How to Unify Swagger2.0 Docs with GF2 Routing: A Practical Guide

This article analyzes the shortcomings of separating Swagger2.0 documentation from parameter handling in a Go backend, proposes a unified parameter definition and routing adapter for the GF framework, and demonstrates the resulting automatic OpenAPI generation with detailed code flow and visual examples.

API documentationBackendGF framework
0 likes · 8 min read
How to Unify Swagger2.0 Docs with GF2 Routing: A Practical Guide
Tongcheng Travel Technology Center
Tongcheng Travel Technology Center
May 6, 2024 · Operations

Using smart-doc to Generate JMeter Performance Test Scripts and Integrate with Prometheus and Grafana

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.

API documentationGrafanaJMeter
0 likes · 7 min read
Using smart-doc to Generate JMeter Performance Test Scripts and Integrate with Prometheus and Grafana
Test Development Learning Exchange
Test Development Learning Exchange
Mar 26, 2024 · Backend Development

Using pdoc to Generate API Documentation for Python Projects

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.

API documentationCLIDocumentation Generation
0 likes · 5 min read
Using pdoc to Generate API Documentation for Python Projects
Architect
Architect
Dec 31, 2023 · Industry Insights

How Mooncake Automated API Documentation and Built a Metadata Hub

The article details how the Mooncake platform tackled outdated, manually‑maintained API docs by introducing naming conventions, a one‑click IntelliJ plugin, GitLab MR auto‑parsing, and a metadata center that supports debugging, mocking, and downstream consumption, saving developers hundreds of hours per release.

API documentationAutomationDebugging
0 likes · 18 min read
How Mooncake Automated API Documentation and Built a Metadata Hub
NetEase Cloud Music Tech Team
NetEase Cloud Music Tech Team
Nov 29, 2023 · Backend Development

Design and Implementation of a Code‑Centric Automated API Documentation Management Platform

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.

API documentationAST ParsingAutomated Documentation
0 likes · 9 min read
Design and Implementation of a Code‑Centric Automated API Documentation Management Platform
Su San Talks Tech
Su San Talks Tech
Oct 4, 2023 · Backend Development

Master Swagger: Build, Customize, and Secure Your Spring Boot API Docs

This guide explains what Swagger is, why it’s useful for RESTful APIs, and provides step‑by‑step instructions for integrating Swagger 3.0 with Spring Boot 2.7, handling version conflicts, customizing documentation, adding security, and using annotations to enrich API metadata.

API documentationJavaSpring Boot
0 likes · 22 min read
Master Swagger: Build, Customize, and Secure Your Spring Boot API Docs
DeWu Technology
DeWu Technology
Sep 4, 2023 · Backend Development

How Mooncake Automates API Docs, Builds a Metadata Hub, and Boosts Development Efficiency

This article examines the challenges of manual API documentation, introduces Mooncake’s standardized organization, the MooncakeUpload IntelliJ plugin for one‑click doc generation, GitLab MR auto‑parsing for continuous updates, and the API metadata center that enhances debugging, mocking, and cross‑team collaboration.

API documentationAutomationBackend Tools
0 likes · 19 min read
How Mooncake Automates API Docs, Builds a Metadata Hub, and Boosts Development Efficiency
IT Services Circle
IT Services Circle
Sep 2, 2023 · Backend Development

Using Swagger for API Documentation in Spring Boot: Setup, Configuration, and Customization

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.

API documentationBackend DevelopmentJava
0 likes · 20 min read
Using Swagger for API Documentation in Spring Boot: Setup, Configuration, and Customization
Wukong Talks Architecture
Wukong Talks Architecture
Aug 29, 2023 · Backend Development

Using Swagger with Spring Boot: Setup, Configuration, and Common Issues

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.

API documentationJavaSpring Boot
0 likes · 16 min read
Using Swagger with Spring Boot: Setup, Configuration, and Common Issues
High Availability Architecture
High Availability Architecture
Aug 22, 2023 · Backend Development

Practical Tips for Improving Interface Maintainability in Software Development

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.

API documentationBackend DevelopmentInterface Design
0 likes · 15 min read
Practical Tips for Improving Interface Maintainability in Software Development
JD Tech
JD Tech
Jul 19, 2023 · Backend Development

Practical Tips for Improving Interface Maintainability in Software Development

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.

API documentationJavainterface maintainability
0 likes · 15 min read
Practical Tips for Improving Interface Maintainability in Software Development
DaTaobao Tech
DaTaobao Tech
Mar 17, 2023 · Backend Development

Automating Cross‑Platform API Documentation with Java Annotations at Taobao Search

This article explains how the Taobao Search team tackled the inconsistency and high maintenance cost of manually written API docs by introducing a standardized annotation format, a custom annotation processor, automated JSON generation, and script‑based data reporting to keep cross‑platform API information accurate and readily usable for both backend and frontend developers.

API documentationAutomationBackend Development
0 likes · 8 min read
Automating Cross‑Platform API Documentation with Java Annotations at Taobao Search
macrozheng
macrozheng
Feb 9, 2023 · Backend Development

Auto‑Generate Spring API Docs in IDEA with Apifox Helper Plugin

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.

API documentationApifoxAutomated Testing
0 likes · 8 min read
Auto‑Generate Spring API Docs in IDEA with Apifox Helper Plugin
php Courses
php Courses
Dec 2, 2022 · Backend Development

Understanding API Documentation: Purpose, Standards, and Efficient Production

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.

API documentationAutomationBackend Development
0 likes · 4 min read
Understanding API Documentation: Purpose, Standards, and Efficient Production
DeWu Technology
DeWu Technology
Nov 24, 2022 · Frontend Development

API Documentation‑Driven Development in Front‑End Functional Teams

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.

API documentationLowCodedevelopment process
0 likes · 3 min read
API Documentation‑Driven Development in Front‑End Functional Teams
FunTester
FunTester
Oct 27, 2022 · Backend Development

How to Fix @RequestBody Compatibility and Swagger Timeout Issues in Spring Boot

This article explains why @RequestBody conflicts with Swagger in Spring Boot, outlines two common but cumbersome work‑arounds, describes a Swagger API timeout caused by Groovy's MetaClass, and provides a concise configuration fix that eliminates both the timeout and the compatibility issue.

@RequestBodyAPI documentationGroovy
0 likes · 4 min read
How to Fix @RequestBody Compatibility and Swagger Timeout Issues in Spring Boot
macrozheng
macrozheng
Jul 20, 2022 · Backend Development

Boost Swagger Docs with SpringDoc and Knife4j: A Practical Guide

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.

API documentationJavaKnife4j
0 likes · 6 min read
Boost Swagger Docs with SpringDoc and Knife4j: A Practical Guide
Baidu Geek Talk
Baidu Geek Talk
Jul 4, 2022 · Backend Development

Integrating Swagger with Yapi for Automated API Documentation in Go

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.

API documentationAutomationGo
0 likes · 14 min read
Integrating Swagger with Yapi for Automated API Documentation in Go
Java High-Performance Architecture
Java High-Performance Architecture
Apr 5, 2022 · Backend Development

Boost Your Java Projects with Sa-plus: A High‑Performance SpringBoot Code Generator

This guide introduces Sa-plus, a SpringBoot‑based rapid development framework featuring a built‑in code generator, dual UI skins, and integrated JavaWeb utilities, and walks you through setting up the database, importing modules, configuring the application, and automatically generating full‑stack CRUD code and API documentation.

API documentationCode GenerationJavaWeb
0 likes · 12 min read
Boost Your Java Projects with Sa-plus: A High‑Performance SpringBoot Code Generator
21CTO
21CTO
Mar 23, 2022 · Fundamentals

Java 18: New Features That Accelerate Development

Java 18, released by Oracle as a non‑LTS incremental update, introduces a simple web server, enhanced API documentation with syntax‑highlighted code snippets, and switches the default charset to UTF‑8, offering developers faster testing, clearer docs, and consistent encoding across platforms.

API documentationJavaJava 18
0 likes · 4 min read
Java 18: New Features That Accelerate Development
Code Ape Tech Column
Code Ape Tech Column
Feb 14, 2022 · Backend Development

Aggregating Swagger API Documentation in Spring Cloud Gateway

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.

API documentationJavaSpring Cloud
0 likes · 8 min read
Aggregating Swagger API Documentation in Spring Cloud Gateway
Java Backend Technology
Java Backend Technology
Feb 11, 2022 · Backend Development

Boost Your Spring Boot API Docs: Switch from Swagger to Knife4j for Better UI

This article explains why Swagger can become cumbersome as API counts grow, introduces Knife4j as a powerful Swagger enhancement, and provides step‑by‑step instructions with code examples to integrate Knife4j into a Spring Boot project, highlighting its key features such as JSON folding, search, and global parameters.

API documentationJavaKnife4j
0 likes · 10 min read
Boost Your Spring Boot API Docs: Switch from Swagger to Knife4j for Better UI
Baidu Geek Talk
Baidu Geek Talk
Dec 29, 2021 · Backend Development

How to Seamlessly Sync Swagger Docs to Yapi for Automatic API Updates

This guide explains how to keep Swagger annotations in sync with Yapi by generating a swagger.json file, exposing it via Nginx, and configuring Yapi’s automatic import, so that API documentation updates automatically after each code change without manual effort.

API documentationAutomationGo
0 likes · 14 min read
How to Seamlessly Sync Swagger Docs to Yapi for Automatic API Updates
Java Architect Essentials
Java Architect Essentials
Dec 19, 2021 · Frontend Development

think-swagger-ui-vuele: A Custom Swagger UI Implementation for Think-Vuele

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.

API documentationSwaggerUI
0 likes · 6 min read
think-swagger-ui-vuele: A Custom Swagger UI Implementation for Think-Vuele
Selected Java Interview Questions
Selected Java Interview Questions
Nov 23, 2021 · Backend Development

Integrating Knife4j with Spring Boot for Enhanced Swagger API Documentation

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.

API documentationKnife4jSwagger
0 likes · 8 min read
Integrating Knife4j with Spring Boot for Enhanced Swagger API Documentation
macrozheng
macrozheng
Oct 9, 2021 · Backend Development

Master Swagger Integration in SpringBoot: Step-by-Step Guide & Advanced Features

This article walks through integrating Swagger into a SpringBoot project, covering dependency setup, configuration, handling common issues like ResponseBodyAdvice conflicts, enhancing UI with Knife4j, and leveraging Swagger’s grouping feature for parameter validation, providing complete code snippets and troubleshooting tips for seamless API documentation.

API documentationJavaKnife4j
0 likes · 14 min read
Master Swagger Integration in SpringBoot: Step-by-Step Guide & Advanced Features
Code Ape Tech Column
Code Ape Tech Column
Sep 4, 2021 · Backend Development

Knife4j: A Lightweight Swagger UI Enhancement for Java MVC Frameworks

Knife4j is a lightweight, feature‑rich solution that enhances Swagger UI for Java MVC frameworks, offering customizable configurations, offline document export, and seamless integration with Spring Boot and Spring Cloud micro‑service architectures, while providing open‑source repositories and clear usage instructions.

API documentationJavaKnife4j
0 likes · 5 min read
Knife4j: A Lightweight Swagger UI Enhancement for Java MVC Frameworks
FunTester
FunTester
Aug 31, 2021 · R&D Management

What Makes an API Document Truly Effective? From Basic to Excellent

The article outlines practical criteria for creating qualified and excellent API documentation, covering project overview, modular organization, request/response details, maintenance practices, and common pitfalls, illustrated with a Jira issue‑creation example, to help testers and developers improve efficiency and communication.

API documentationSoftware qualitybest practices
0 likes · 12 min read
What Makes an API Document Truly Effective? From Basic to Excellent
Programmer DD
Programmer DD
Aug 28, 2021 · Backend Development

Master the Updated Spring Boot Swagger Starter with Pure Configuration

This article explains the history, recent updates, and step‑by‑step usage of the Spring Boot Swagger starter, including dependency setup, detailed configuration options, grouping, JSR‑303 validation support, custom response messages, UI tweaks, ignored parameter types, and authorization settings.

API documentationBackend DevelopmentConfiguration
0 likes · 17 min read
Master the Updated Spring Boot Swagger Starter with Pure Configuration
Java Backend Technology
Java Backend Technology
Jul 17, 2021 · Backend Development

Unlock Powerful API Docs with Knife4j: A Complete Guide for Java Backend Developers

Knife4j is a lightweight, feature‑rich enhancement for Swagger that integrates seamlessly with Java MVC frameworks, offering customizable UI, advanced functionalities like interface sorting and export options, and easy Maven integration for both monolithic Spring Boot and Spring Cloud microservice architectures.

API documentationBackend DevelopmentJava
0 likes · 7 min read
Unlock Powerful API Docs with Knife4j: A Complete Guide for Java Backend Developers
New Oriental Technology
New Oriental Technology
Jul 13, 2021 · Backend Development

Integrating Swagger with Dubbo for API Documentation and Testing

This article explains why Swagger‑Dubbo is needed, introduces Swagger, describes the Swagger‑Dubbo tool, provides step‑by‑step integration instructions with Maven dependencies and Java configuration code, demonstrates how to launch and test the generated API docs, and outlines additional integrations with Knife4j and YApi.

API documentationBackendDubbo
0 likes · 8 min read
Integrating Swagger with Dubbo for API Documentation and Testing
Top Architect
Top Architect
Apr 5, 2021 · Backend Development

Integrating Swagger (Springfox) 3.0.0 with Spring Boot for Automatic API Documentation

This article explains how to integrate Swagger using Springfox 3.0.0 into a Spring Boot project, covering required dependencies, configuration files, annotations, new features, compatibility requirements, and provides a complete example with code snippets for generating interactive OpenAPI documentation.

API documentationBackend DevelopmentOpenAPI
0 likes · 11 min read
Integrating Swagger (Springfox) 3.0.0 with Spring Boot for Automatic API Documentation
Top Architect
Top Architect
Mar 8, 2021 · Backend Development

Integrating Swagger‑Bootstrap‑UI (Knife4j) into a Spring Boot Project

This tutorial explains how to replace the default Swagger UI with Swagger‑Bootstrap‑UI (now called Knife4j) in a Spring Boot application, covering Maven dependencies, configuration classes, common annotations, a sample controller, launch steps, and troubleshooting tips.

API documentationBackend DevelopmentJava
0 likes · 6 min read
Integrating Swagger‑Bootstrap‑UI (Knife4j) into a Spring Boot Project
macrozheng
macrozheng
Jan 6, 2021 · Backend Development

Essential Spring Boot Practices for Building Robust Microservices

This article outlines the golden rules for constructing Spring Boot microservices, covering monitoring with Spring Boot Admin and Grafana, exposing metrics via Actuator, centralized logging with ELK, clear API documentation using Swagger, YApi or smart‑doc, transparent build info, and keeping dependencies up‑to‑date.

API documentationMicroservicesSpring Boot
0 likes · 8 min read
Essential Spring Boot Practices for Building Robust Microservices
Java Architecture Diary
Java Architecture Diary
Jan 3, 2021 · Backend Development

Essential Spring Boot Practices for Building Robust Microservices

This guide outlines essential Spring Boot best practices for microservices, covering monitoring with Admin and Grafana, Actuator metrics, centralized logging via ELK, clear API docs using Swagger, YApi or smart-doc, build-info transparency, and keeping dependencies up-to-date.

API documentationActuatorSpring Boot
0 likes · 8 min read
Essential Spring Boot Practices for Building Robust Microservices
Byte Quality Assurance Team
Byte Quality Assurance Team
Dec 3, 2020 · Backend Development

How GinDoc Turns Go Code into Swagger Docs and Test Models

The article explains the challenges of keeping interface model definitions synchronized between development and testing, compares code‑first and doc‑first approaches, introduces the Go‑based GinDoc library for generating Swagger documentation and client code from annotated routes, and provides step‑by‑step usage examples and integration tips.

API documentationCode GenerationDoc-first
0 likes · 8 min read
How GinDoc Turns Go Code into Swagger Docs and Test Models
Su San Talks Tech
Su San Talks Tech
Dec 3, 2020 · Backend Development

Which Open‑Source API Documentation Tool Is Right for Your OpenAPI Platform?

This article compares several open‑source API documentation generators—GitBook, smart‑doc, Redoc, Knife4j, YAPI, apidoc, and ShowDoc—evaluating their licenses, popularity, language support, features, pros, cons, and suitability for real‑time online documentation, search, and debugging.

API documentationSwaggerTool comparison
0 likes · 13 min read
Which Open‑Source API Documentation Tool Is Right for Your OpenAPI Platform?
Node Underground
Node Underground
Nov 10, 2020 · Backend Development

Accelerate Midway Development with a Minimal Swagger Component

This article introduces Midway's lightweight, dependency‑free Swagger component that leverages the framework’s own decorators to generate Swagger‑compatible JSON, explains its advantages and limitations, showcases code examples for multi‑scenario service injection, details recent configuration refactoring that speeds up local development, and highlights new request‑parameter decorators for richer API documentation.

API documentationConfigurationMidway
0 likes · 7 min read
Accelerate Midway Development with a Minimal Swagger Component
Top Architect
Top Architect
Nov 7, 2020 · Backend Development

Integrating Swagger with Spring Boot Using Springfox 3.0.0

This article provides a comprehensive guide on using Swagger for REST API documentation in Spring Boot projects, covering Swagger fundamentals, Springfox introduction, the features of Springfox 3.0.0, compatibility requirements, Maven integration, configuration classes, common annotations, and a complete example with code snippets.

API documentationJavaOpenAPI
0 likes · 11 min read
Integrating Swagger with Spring Boot Using Springfox 3.0.0
Code Ape Tech Column
Code Ape Tech Column
Nov 5, 2020 · Backend Development

Master Swagger 3.0 Integration with Spring Boot: Step‑by‑Step Guide

This article walks through the complete process of integrating Swagger 3.0 into a Spring Boot 2.3.5 application, covering dependency setup, the role of springfox‑boot‑starter, custom OpenAPI configuration, API grouping, security schemes, and global request parameters with concrete code examples.

API documentationConfigurationJava
0 likes · 11 min read
Master Swagger 3.0 Integration with Spring Boot: Step‑by‑Step Guide
Laiye Technology Team
Laiye Technology Team
Nov 4, 2020 · Backend Development

Protobuf Practices and Lessons Learned at Laiye Technology

This article shares Laiye Technology's practical experience with Protobuf and gRPC, covering performance benefits, common pitfalls such as naming and compatibility issues, and the engineering solutions they implemented—including naming conventions, review processes, unified CI compilation, automatic client generation, version tagging, and Swagger documentation—to streamline large‑scale microservice development.

API documentationMicroservicesProtobuf
0 likes · 17 min read
Protobuf Practices and Lessons Learned at Laiye Technology
php Courses
php Courses
Nov 3, 2020 · Backend Development

Integrating swagger-php 2.0 with ThinkPHP to Generate API Documentation

This tutorial walks through installing swagger-php 2.0, downloading swagger-ui, integrating it into a ThinkPHP project, generating a swagger.json file via annotations, and provides code snippets and configuration details to help developers set up API documentation in a PHP backend environment.

API documentationSwaggerswagger-php
0 likes · 2 min read
Integrating swagger-php 2.0 with ThinkPHP to Generate API Documentation
macrozheng
macrozheng
Jul 23, 2020 · Cloud Native

How to Aggregate Microservice APIs with Spring Cloud Gateway and Knife4j

Learn to unify API documentation across multiple Spring Cloud microservices by configuring Nacos, Spring Cloud Gateway, and Knife4j, covering prerequisite setup, service definitions, detailed implementation steps, Swagger resource aggregation, UI switching, and complete code examples for user, order, and gateway services.

API documentationKnife4jMicroservices
0 likes · 13 min read
How to Aggregate Microservice APIs with Spring Cloud Gateway and Knife4j
Programmer DD
Programmer DD
Jul 17, 2020 · Backend Development

SpringFox 3.0.0 Quick Guide: Swagger Integration for Spring Boot

This article introduces SpringFox 3.0.0, highlights its new features such as Spring 5 WebFlux support, OpenAPI 3 compatibility, and zero‑configuration starter, then provides a step‑by‑step guide with Maven dependencies, annotations, controller examples, and notes on updated Swagger UI endpoints.

API documentationBackendJava
0 likes · 7 min read
SpringFox 3.0.0 Quick Guide: Swagger Integration for Spring Boot
ITFLY8 Architecture Home
ITFLY8 Architecture Home
Mar 10, 2020 · Backend Development

Master Swagger: Seamless API Docs & Testing in Spring Boot

This article explains what Swagger is, why it benefits backend and frontend teams, and provides a step‑by‑step guide to integrate Swagger 2.7.0 into a Spring Boot project, including dependencies, configuration, annotations, controller examples, testing tips, and deployment considerations.

API documentationBackend DevelopmentSpring Boot
0 likes · 10 min read
Master Swagger: Seamless API Docs & Testing in Spring Boot
21CTO
21CTO
Dec 24, 2019 · Backend Development

Why API Documentation Matters: 5 Common Mistakes and How to Fix Them

This article examines five frequent problems in API design—missing or incomplete documentation, lack of parameter validation, non‑atomic operations, and recurring interface issues—explaining why they frustrate front‑end developers and offering practical solutions such as proper documentation practices, enriched response structures, and rigorous validation.

API documentationInterface DesignSoftware Engineering
0 likes · 7 min read
Why API Documentation Matters: 5 Common Mistakes and How to Fix Them
Programmer DD
Programmer DD
Oct 17, 2019 · Backend Development

How to Generate Static API Docs with Swagger2Markup for Spring Boot

This guide explains how to use Swagger2Markup to convert Swagger-generated API specifications into static documentation formats such as AsciiDoc, Markdown, Confluence markup, and HTML, covering both Java code and Maven plugin approaches, deployment options, and example configurations for Spring Boot projects.

API documentationAsciiDocConfluence
0 likes · 12 min read
How to Generate Static API Docs with Swagger2Markup for Spring Boot
YooTech Youzu Tech Team
YooTech Youzu Tech Team
Sep 26, 2019 · Backend Development

Effortlessly Generate Beautiful Go API Docs with Swagger and Swag

This guide walks you through the challenges of manual API documentation, introduces Swagger as a powerful solution, and provides a step‑by‑step tutorial for integrating Swagger with Go projects using the Swag tool, Gin framework, and custom UI enhancements.

API documentationBackend DevelopmentGin
0 likes · 9 min read
Effortlessly Generate Beautiful Go API Docs with Swagger and Swag
macrozheng
macrozheng
May 8, 2019 · Backend Development

How to Integrate Swagger‑UI for Complete API Documentation in a Spring Boot Mall Project

This tutorial walks through integrating Swagger‑UI into the mall‑tiny Spring Boot project, covering Maven dependencies, Java configuration, adding Swagger annotations to controllers, customizing MyBatis Generator to emit @ApiModelProperty, regenerating model code, and finally viewing and testing the generated API docs via the Swagger‑UI interface.

API documentationJavaMyBatis Generator
0 likes · 10 min read
How to Integrate Swagger‑UI for Complete API Documentation in a Spring Boot Mall Project
Programmer DD
Programmer DD
Oct 22, 2018 · Backend Development

Mastering Swagger: Configuring allowableValues in @ApiModelProperty

This guide explains how to use the Swagger @ApiModelProperty annotation's allowableValues attribute to define fixed lists, numeric ranges, or open-ended limits for API parameters, with clear Java code examples and the resulting documentation output.

API documentationSwaggerallowablevalues
0 likes · 4 min read
Mastering Swagger: Configuring allowableValues in @ApiModelProperty
Youzan Coder
Youzan Coder
Jun 12, 2018 · R&D Management

ZanApi: YouZan's Solution for Frontend-Backend Collaboration and API Management

ZanApi, YouZan’s integrated tool, streamlines frontend‑backend collaboration by auto‑generating API documentation via an IntelliJ plugin, providing dynamic mock services through ZanProxy with schema‑based data generation, and enabling one‑click integration testing and validation, thus reducing maintenance overhead and accelerating development cycles.

API documentationAPI testingYouzan
0 likes · 9 min read
ZanApi: YouZan's Solution for Frontend-Backend Collaboration and API Management
Programmer DD
Programmer DD
Mar 20, 2018 · Backend Development

Generate Spring REST Docs API Documentation in Minutes with Gradle or Maven

This step‑by‑step guide shows how to create a simple Spring Boot application, configure Gradle or Maven builds, write MockMvc tests, and use Spring REST Docs to automatically generate up‑to‑date API documentation snippets that can be included in Asciidoctor‑based docs.

API documentationGradleREST Docs
0 likes · 17 min read
Generate Spring REST Docs API Documentation in Minutes with Gradle or Maven
Programmer DD
Programmer DD
Jan 28, 2018 · Backend Development

Convert Swagger Docs to Markdown and Confluence with Swagger2Markup

This tutorial explains how to use the open‑source Swagger2Markup library to transform Swagger/OpenAPI specifications into Markdown or Confluence markup by adjusting a single Java configuration, includes code examples, output structure, single‑file options, and deployment tips for static sites and Confluence.

API documentationConfluenceJava
0 likes · 5 min read
Convert Swagger Docs to Markdown and Confluence with Swagger2Markup
dbaplus Community
dbaplus Community
Dec 20, 2017 · Backend Development

How Ele.me’s API Everything Framework Transforms Backend Service Integration

This article summarizes Liang Xiangdong’s talk on the API Everything framework at the Gdevops 2017 conference, detailing the motivations, design principles, lifecycle, key products such as Stargate Cluster and API Portal, and the practical impact on backend development, DevOps automation, and front‑end/back‑end separation at Ele.me.

APIAPI documentationAutomation
0 likes · 21 min read
How Ele.me’s API Everything Framework Transforms Backend Service Integration
Programmer DD
Programmer DD
Aug 28, 2017 · Backend Development

Quickly Add Swagger2 API Docs to Spring Boot with the Swagger Starter

This article introduces the Spring Boot Swagger starter version 1.3.0.RELEASE, highlighting new host configuration and JSR‑303 annotation support, and provides step‑by‑step instructions, Maven dependency snippets, Java code, detailed property settings, grouping examples, and resource links for seamless API documentation integration.

API documentationBackend DevelopmentConfiguration
0 likes · 7 min read
Quickly Add Swagger2 API Docs to Spring Boot with the Swagger Starter
Programmer DD
Programmer DD
Aug 20, 2017 · Backend Development

Quickly Add Swagger2 to Spring Boot with Auto-Configuration Starter

This guide shows how to quickly integrate Swagger2 into a Spring Boot 1.5.x application using the spring-boot-starter-swagger, covering Maven dependency setup, annotation usage, detailed property configuration for titles, versions, licenses, path rules, and advanced grouping features introduced in version 1.2.0.RELEASE.

API documentationBackend DevelopmentJava
0 likes · 6 min read
Quickly Add Swagger2 to Spring Boot with Auto-Configuration Starter
System Architect Go
System Architect Go
Mar 21, 2017 · Cloud Computing

Deploy API Documentation with GitHub Pages: A Step‑by‑Step Guide

This article explains how to automatically generate API documentation using apidoc, host the resulting static files on GitHub Pages, configure the repository settings to serve the docs folder, and obtain a public URL that front‑end developers can access without manual file transfers.

API documentationDeploymentGitHub Pages
0 likes · 4 min read
Deploy API Documentation with GitHub Pages: A Step‑by‑Step Guide
Architects Research Society
Architects Research Society
Nov 20, 2015 · Backend Development

Integrating Swagger 2.0 with Spring Boot Using Springfox

This tutorial explains how to add Swagger 2.0 API documentation to a Spring Boot application by configuring Maven dependencies, enabling Swagger with Springfox annotations, creating a Docket bean, and annotating controllers and model classes to generate an interactive API explorer.

API documentationSpringBootSpringfox
0 likes · 10 min read
Integrating Swagger 2.0 with Spring Boot Using Springfox