Axim Restdoc Generator
ListedAxim Restdoc Generator automatically creates comprehensive REST API documentation from your code, saving time and ensuring consistent, up-to-date records.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add axim-one/gradle-restdoc-generator --skill axim-restdoc-generator -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
axim-one
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.
Automated safety checks
This skill failed 1 of 6 checks. A failure is not proof of bad intent; it means something in the code needs a human to look at it before you run it.
No undeclared network calls: failed
Contacts 3 hosts that are neither well-known infrastructure nor declared in the skill's frontmatter: api.getpostman.com, context7.com, schema.getpostman.com.
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
context7.comundeclaredwww.apache.orgstandardsschema.getpostman.comundeclaredapi.getpostman.comundeclaredWhat it found (3 of 11)
- README.md:487contacts context7.com
curl "https://context7.com/api/v2/libs/search?libraryName=gradle-restdoc-generator" - README.md:490contacts context7.com
curl "https://context7.com/api/v2/context?libraryId=/axim-one/gradle-restdoc-generator&topic=configuration" - context7.json:2contacts context7.com
"url": "https://context7.com/axim-one/gradle-restdoc-generator",
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 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 axim-one/gradle-restdoc-generator at 8daef6bea4.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 8daef6bea4
- Manifest
- SKILL.md
- Scanned
- 60 files, 9,209 lines
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.