spring-boot-openapi-documentation

仓库创建 2025年10月21日最近提交 1 个月前SkillHot 收录 22 天前

▸ 精选理由

快速生成可交互的 API 规范，方便开发与测试接口契约。

这个 Skill 做什么

使用 SpringDoc/OpenAPI 为 Spring Boot 自动生成 REST API 文档并启用 Swagger UI。

帮你在 Spring Boot 3.x 项目里自动生成 OpenAPI（SpringDoc）规范并启用可交互的 Swagger UI，方便前后端联调和接口自文档化。创建或增强 REST 接口文档、添加注解、示例、模式和安全说明时会用到，省去手写规范的烦恼。特点是与 SpringDoc/OpenAPI 紧密集成，能生成完整的可测试 API 页面。

▸ 展开 SKILL.md 英文原文

Provides patterns to generate comprehensive REST API documentation using SpringDoc OpenAPI 3.0 and Swagger UI in Spring Boot 3.x applications. Use when setting up API documentation, configuring Swagger UI, adding OpenAPI annotations, implementing security documentation, or enhancing REST endpoints with examples and schemas.

开发编程OpenAPI文档SpringDoc通用

311

Stars

Forks

仓库内 Skill

+10

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/giuseppe-trisciuoglio/developer-kit/main/plugins/developer-kit-java/skills/spring-boot-openapi-documentation/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/giuseppe-trisciuoglio/developer-kit/main/plugins/developer-kit-java/skills/spring-boot-openapi-documentation/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# Spring Boot OpenAPI Documentation with SpringDoc

## Overview

SpringDoc OpenAPI automates generation of OpenAPI 3.0 documentation for Spring Boot projects with a Swagger UI web interface for exploring and testing APIs.

## When to Use

- Set up SpringDoc OpenAPI in Spring Boot 3.x projects
- Generate OpenAPI 3.0 specifications for REST APIs
- Configure and customize Swagger UI
- Add detailed API documentation with annotations
- Document request/response models with validation
- Implement API security documentation (JWT, OAuth2, Basic Auth)
- Document pageable and sortable endpoints
- Add examples and schemas to API endpoints
- Customize OpenAPI definitions programmatically
- Support multi

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有