neopjm109/agent.oliver/api-docs-generator

Claude Code and agent skill by neopjm109/agent.oliver

Trust tier 3
  • community
Source check pending

Checking that the SKILL.md file is still in the repository.

Generate runtime Spring Boot API documentation via springdoc-openapi — annotations, OpenAPI config, grouping, and Swagger UI.

Install

npx vskill@latest install neopjm109/agent.oliver/api-docs-generator

SKILL.md

The same SKILL.md was published earlier as neopjm109/agent.oliver/api-docs-generator.

Goal

Generate runtime API documentation for existing Spring Boot controllers using springdoc-openapi: an OpenAPI config bean, operation/schema annotations, endpoint grouping, examples, and Swagger UI exposure. This skill documents the runtime API surface; the design-time contract is owned by api-spec-generator (blueprint) — this reflects and annotates the actually-implemented controllers from api-generator.

Inputs

yaml
api_docs_requirements:
title: Shop API
version: v1
groups: [orders, users]
security_scheme: bearer-jwt # aligns with security-generator
controllers: [OrderController, UserController]
expose_ui: true # /swagger-ui

Output

yaml
api_docs_code:
- OpenApiConfig (info, servers, security scheme, grouped OpenAPI beans)
- @Operation / @ApiResponse / @Schema annotations on controllers + DTOs
- springdoc config in application.yml (ui path, packages-to-scan)

Workflow

Step 1 — Configure the document

Define API info, servers, security scheme (matching security-generator), and grouped definitions.

Step 2 — Annotate operations

Add @Operation, @ApiResponse, and @Schema to controllers/DTOs; include realistic examples.

Step 3 — Expose UI and grouping

Configure Swagger UI path and GroupedOpenApi beans per functional area.

Step 4 — Delegate implementation

Delegate the config bean and annotations to spring-senior-programmer.

Rules

  • Document runtime controllers only; the design-time OpenAPI contract belongs to api-spec-generator.
  • Keep the security scheme consistent with security-generator (same token/OAuth model).
  • Do not expose Swagger UI in production unless explicitly allowed; gate by profile.
  • Annotations must not alter behavior — documentation only, no business logic.
  • Keep examples realistic and free of secrets/PII.

Examples

Input:

yaml
api_docs_requirements:
title: Shop API
version: v1
groups: [orders]
security_scheme: bearer-jwt
expose_ui: true

Output (abridged):

java
@Configuration
public class OpenApiConfig {
@Bean
OpenAPI shopApi() {
return new OpenAPI()
.info(new Info().title("Shop API").version("v1"))
.components(new Components().addSecuritySchemes("bearer-jwt",
new SecurityScheme().type(SecurityScheme.Type.HTTP).scheme("bearer").bearerFormat("JWT")))
.addSecurityItem(new SecurityRequirement().addList("bearer-jwt"));
}
@Bean
GroupedOpenApi ordersGroup() {
return GroupedOpenApi.builder().group("orders").pathsToMatch("/orders/**").build();
}
}

Security

  • Security scanPassed, 90 of 100Pattern checks on the skill's files.
  • Model reviewPassed

Quality evaluation

  • Task evaluationNot runNo evaluation yet. Run one in Skill Studio.

Source

Popularity

7-day trend score
5

Not refreshed yet.

Works with

Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.

  • Claude Code
  • Cursor
  • GitHub Copilot
  • Windsurf
  • Codex
  • Gemini CLI
  • Cline
  • Amp
  • Roo Code
  • Goose
  • Continue
  • Kilo Code
  • Junie
  • Trae
  • OpenHands
  • Qwen Code
  • AI Agent
  • Tabnine Chat
  • Sourcegraph Cody
  • Amazon Q
  • Firebase Genkit
  • Sweep
  • Devin
  • Phind
  • Mentat
  • Claude Desktop
  • Aider
  • GPT Pilot
  • Plandex
  • bolt.new
  • v0
  • Replit Agent
  • Anse
  • TypingMind
  • BetterChatGPT
  • LibreChat
  • Warp AI
  • Pieces
  • Fig AI
Embed badge
vskill VERIFIED badge
[![vskill VERIFIED](https://verified-skill.com/api/v1/skills/neopjm109/agent.oliver/api-docs-generator/badge)](https://verified-skill.com/skills/neopjm109/agent.oliver/api-docs-generator)

Something wrong with this skill or its page? Tell us.