Spring Boot OpenAPI Documentation with SpringDoc Agent Skill

Provides patterns to generate comprehensive REST API documentation using SpringDoc OpenAPI 3.0 and Swagger UI in Spring Boot 3.x…

Context cost
26.8k tokensestimated from the bundle, loaded when it triggers
Bundle
14 files · 107.1 kBtext throughout, nothing executable
Licence
MITthe author’s own terms
Last change
—no release on file
Servers it uses
Noneruns standalone

What it does

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.

What this skill changes about the agent has not been set out here as a list. Its SKILL.md, shown below, says it in the author’s own words.

apidocumentationopenapirestspring

The skill itself

A skill is instructions the model reads, so you can see what you are getting: below is the start of its SKILL.md. The front matter loads with every session, the body loads when the skill triggers, and the whole file comes with the install.

SKILL.md10.4 kB · preview
--- name: spring-boot-openapi-documentation allowed-tools: Read, Write, Edit, Bash, Glob, Grep ---
7# Spring Boot OpenAPI Documentation with SpringDoc
8
9## Overview
10
11SpringDoc OpenAPI automates generation of OpenAPI 3.0 documentation for Spring Boot projects with a Swagger UI web interface for exploring and testing APIs.
12
13## When to Use
14
15- Set up SpringDoc OpenAPI in Spring Boot 3.x projects
16- Generate OpenAPI 3.0 specifications for REST APIs
17- Configure and customize Swagger UI
18- Add detailed API documentation with annotations
19- Document request/response models with validation
20- Implement API security documentation (JWT, OAuth2, Basic Auth)
21- Document pageable and sortable endpoints
22- Add examples and schemas to API endpoints
23- Customize OpenAPI definitions programmatically
24- Support multiple API groups and versions
25- Document error responses and exception handlers
This is a preview of SKILL.md. Download or install the skill to get the whole thing.
In the file
SKILL.md1,070 words
Files14
LicenceMIT
Why you can read it

Nothing in a skill executes. The client loads the text and the model follows it, so a skill can be audited the way a runbook is — by reading it.

What it costs in context

Skills are not billed by the call. They are paid for in context: every token the instructions occupy is a token your code, your diff and your conversation cannot use. Here is what this one takes and when it takes it.

≈110
always loaded
The name and description, so the model knows the skill exists and when to reach for it.
26,665
on trigger
The instruction body and 13 supporting files, read only when the skill fires.
13.4%
of a 200k window
Ten skills this size would not fit in the window together.
050k100k150k200k context window

26.8k tokens, estimated from the bundle at four bytes to the token, held for the rest of the session once it triggers. Heavy. Teams tend to install this one per project rather than globally, and load it only when the job comes up.

Servers bill, skills cost

A server charges by the month. A skill charges once per session, in context, and then keeps charging it for as long as the session lives.

Before and after

The same question, put to the same model twice: once as it comes, and once with these instructions loaded.

No worked example has been published for this skill yet.

The procedure it runs

The procedure has not been set out here step by step. It is in the body of its SKILL.md: the start of it is shown above, and the whole file comes with the install.

Prose, not code

These steps are written for a model to follow, not executed by a runtime. It can still be told to skip one, and it will say so when it does.

Servers it uses

None. This skill calls no MCP servers at all.

Everything it needs is in the instructions, so it works in a project with nothing connected — the model reads the file and changes how it works with what it can already reach.

It asks the agent to write files, using whatever file access your client already has. Whether it reaches the network is not declared.

What it asks for
Writes filesyes
Network accessnot declared

Read from the allowed-tools line of this skill’s own SKILL.md. It also asks for Bash, which could do either, so what is not named there is not ruled out. A skill grants no permissions of its own — it can only ask for tools your client already has.

What it will not do

Every skill is narrow, and the useful ones say where they stop. These are the jobs this one is the wrong tool for.

What this skill is not for has not been published here. Nothing is implied by that: it is a section the author has not filled in.

What is in the bundle

14 files, 107.1 kB on disk. A bundle is text throughout: the instructions the model reads, plus the templates it fills in.

  • SKILL.md10.4 kB
  • references/advanced-configuration.md8.9 kB
  • references/annotations-reference.md10.0 kB
  • references/build-integration.md7.8 kB
  • references/complete-examples.md11.5 kB
  • references/configuration.md1.8 kB
  • references/controller-documentation.md4.2 kB
  • references/dependency-setup.md1.3 kB
  • references/exception-handling.md9.0 kB
  • references/model-documentation.md4.8 kB
  • references/pagination-support.md6.1 kB
  • references/security-configuration.md7.0 kB
  • references/springdoc-official.md17.2 kB
  • references/troubleshooting.md7.1 kB
What is not in it

No dependencies and nothing executable: a skill is text the agent reads, so the bundle is 14 files you can review in full before installing. The MIT licence covers the templates and examples as well as the instructions.

Install

Installing copies the bundle into your project. Nothing runs at install time — the files sit on disk until the model reads them.

# Spring Boot OpenAPI Documentation with SpringDoc · 26.8k tokens when loaded · macOS, Linux mkdir -p .claude/skills && t=$(mktemp -d) && curl -fsSL -o "$t/bundle.tar.gz" https://mcprush.com/api/skills/spring-boot-openapi-documentation-with-springdoc/bundle.tar.gz && tar -xzf "$t/bundle.tar.gz" -C "$t" && [ -d "$t/spring-boot-openapi-documentation-with-springdoc" ] && { [ ! -e .claude/skills/spring-boot-openapi-documentation-with-springdoc ] || { mv .claude/skills/spring-boot-openapi-documentation-with-springdoc "$t/.previous" && echo "Previous copy moved to $t/.previous"; }; } && mv "$t/spring-boot-openapi-documentation-with-springdoc" .claude/skills/ && echo "Installed .claude/skills/spring-boot-openapi-documentation-with-springdoc"
On Windows, or any OS with Node 20+
npx mcprush@latest skill add giuseppe-trisciuoglio/spring-boot-openapi-documentation-with-springdoc

Windows PowerShell says 'running scripts is disabled on this system'? Run Set-ExecutionPolicy -Scope CurrentUser RemoteSigned once, or type npx.cmd instead of npx (codex.cmd, gemini.cmd, grok.cmd likewise). PowerShell 7 needs neither. Writes to .claude/skills/spring-boot-openapi-documentation-with-springdoc/ in the current project. For every project instead, run mkdir -p ~/.claude/skills && t=$(mktemp -d) && curl -fsSL -o "$t/bundle.tar.gz" https://mcprush.com/api/skills/spring-boot-openapi-documentation-with-springdoc/bundle.tar.gz && tar -xzf "$t/bundle.tar.gz" -C "$t" && [ -d "$t/spring-boot-openapi-documentation-with-springdoc" ] && { [ ! -e ~/.claude/skills/spring-boot-openapi-documentation-with-springdoc ] || { mv ~/.claude/skills/spring-boot-openapi-documentation-with-springdoc "$t/.previous" && echo "Previous copy moved to $t/.previous"; }; } && mv "$t/spring-boot-openapi-documentation-with-springdoc" ~/.claude/skills/ && echo "Installed ~/.claude/skills/spring-boot-openapi-documentation-with-springdoc" (macOS, Linux) — or add --global to the npx line. The curl line replaces .claude/skills/spring-boot-openapi-documentation-with-springdoc/ only after the download succeeds, so files left there by another skill of the same name, or by an older release, do not mix in. A copy already there is moved aside, not deleted, and the line prints where. It appears as spring-boot-openapi-documentation in Gemini CLI, Codex, Copilot and Grok (its own name); Claude Code lists it by the folder name, spring-boot-openapi-documentation-with-springdoc.

Which clients pick it up on their own

A skill is a folder of text. Most of these read a skills folder and pick it up without being told; the rest take the same folder another way — an upload in the app, a parameter on an API call — and then choose it by its description just the same.

Claude Code.claude/skills/
Claude DesktopCustomize › Skills
ChatGPTSkills › Create › Upload
Cursor.cursor/skills/
VS Code.github/skills/
Codex CLI.agents/skills/
Gemini CLI.gemini/skills/
Grok Build.grok/skills/
Microsoft CopilotSkills › Upload a skill
PerplexityComputer › Skills › Upload a skill
DeepSeek Harness.dsh/skills/
Zed.agents/skills/
Devin Desktop.devin/skills/
Windsurf (legacy).windsurf/skills/
OpenAI Agents SDKInstructions or sandbox Skills
HTTP / APIa request parameter
This release
Versionnot versioned
Publishedno release date on file
PriceFree
Referencegiuseppe-trisciuoglio/spring-boot-openapi-documentation-with-springdoc

Versions

Its author publishes no version number, so there is nothing here to pin to: what you install is the folder as it stands today. Instructions change more often than APIs do — a skill can be rewritten entirely without anything it depends on moving.

Pinning

Nothing to pin to: this skill carries no version number of its own. What you install is what the folder holds on the day you install it.

Reviews

—no reviews yet

Nobody has reviewed this skill yet. The rating is the mean of the reviews written here, so there is none until somebody writes the first.

Sign in to review it

A review is tied to an account so it can be answered, edited and taken down by the person who wrote it.

Sign in
Who can post

Anybody with an account, one review each. It carries the version that was current when you wrote it, and the publisher may reply once.

Publisher
Servers0
Claim this skill