Axim Restdoc Generator

🌐Community
by axim-one · vlatest · Repository

Axim Restdoc Generator automatically creates comprehensive REST API documentation from your code, saving time and ensuring consistent, up-to-date records.

Install on your platform

We auto-selected Claude Code based on this skill’s supported platforms.

1

Run in terminal (recommended)

terminal
claude mcp add axim-restdoc-generator npx -- -y @trustedskills/axim-restdoc-generator
2

Or manually add to ~/.claude/settings.json

~/.claude/settings.json
{
  "mcpServers": {
    "axim-restdoc-generator": {
      "command": "npx",
      "args": [
        "-y",
        "@trustedskills/axim-restdoc-generator"
      ]
    }
  }
}

Requires Claude Code (claude CLI). Run claude --version to verify your install.

About This Skill

What it does

The axim-restdoc-generator skill generates documentation from REST API specifications. It leverages Gradle, enabling automated generation of comprehensive API documentation directly from source code or specification files. This helps maintain accurate and up-to-date API references for developers.

When to use it

  • Automating API Documentation: When you need a consistent and reliable way to generate API documentation without manual effort.
  • Internal Developer Portals: To create internal developer portals with automatically updated API references.
  • Public API Reference Sites: For publishing public-facing API documentation that stays synchronized with code changes.
  • Project Onboarding: To quickly provide new team members with clear and concise API documentation.

Key capabilities

  • Gradle integration for automated builds.
  • Generation of REST API documentation.
  • Support for various specification formats (implied by "REST API specifications").

Example prompts

  • "Generate API documentation from my OpenAPI spec file."
  • "Build the restdoc project and output to /docs"
  • "Update the API documentation based on recent code changes."

Tips & gotchas

  • Requires a Gradle environment to be set up.
  • The specific format of supported REST API specifications is not detailed, so consult the skill's associated project for compatibility information.

Tags

🛡️

TrustedSkills Verification

Unlike other registries that point to live repositories, TrustedSkills pins every skill to a verified commit hash. This protects you from malicious updates — what you install today is exactly what was reviewed and verified.

Security Audits

Gen Agent Trust HubPass
SocketPass
SnykPass

Details

Version
vlatest
License
Author
axim-one
Installs
4

🌐 Community

Passed automated security scans.