Skip to content
TrustedSkillsbeta
Back to all skills

Spring Boot Openapi Documentation

Checked
giuseppe-trisciuoglio·vlatest·backend·MIT

Generates Spring Boot project OpenAPI documentation (Swagger/ReDoc) from code comments for clear API reference generation.

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add giuseppe-trisciuoglio/developer-kit --skill spring-boot-openapi-documentation -a claude-code
  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

giuseppe-trisciuoglio

Taken from the source listing. We haven't verified who controls this account.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

  • Declares what it does: passed

    SKILL.md parses and declares a name and a description.

    SKILL.md exists, its frontmatter parses, and it declares a name and a description.

  • No undeclared network calls: passed

    Only contacts known or declared hosts: maven.apache.org.

    Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.

    Hosts contacted

    maven.apache.orgnamespace identifier
  • No obfuscated payloads: passed

    No encoded or obfuscated payloads.

    No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.

  • No credential access: passed

    Reads no keys, tokens, keychains or credential files.

    Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.

  • No pipe-to-shell installers: passed

    No pipe-to-shell or download-and-run installers.

    No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.

  • Pinned to a commit: passed

    Scanned giuseppe-trisciuoglio/developer-kit at fe73fb33a0.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Scanned
14 files, 3,526 lines
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

This skill enables AI agents to generate and maintain OpenAPI documentation for Spring Boot applications. It supports the creation of API specifications based on code annotations, ensuring that endpoints, parameters, and responses are accurately described.

When to use it

  • When developing a new RESTful API in Spring Boot and needing up-to-date documentation.
  • When refactoring an existing API and wanting to ensure documentation stays aligned with implementation changes.
  • When preparing for integration testing or third-party developer onboarding by providing clear API definitions.

Key capabilities

  • Auto-generates OpenAPI (Swagger) specs from Spring Boot controllers.
  • Supports annotations like @ApiOperation, @ApiParam, and @ApiResponse.
  • Integrates with tools such as Swagger UI for interactive documentation.

Example prompts

  • "Generate an OpenAPI specification for my Spring Boot REST API."
  • "Update the OpenAPI documentation after adding a new endpoint /user/{id}."
  • "Validate that all endpoints in the Spring Boot application are documented correctly."

Tips & gotchas

  • Ensure your Spring Boot project includes Swagger dependencies (e.g., springdoc-openapi-ui) for full functionality.
  • Custom annotations or non-standard request/response formats may require manual adjustments to the generated documentation.