project-docs-api SKILL.md skillA

project-docs-api from ainiaa/skills-project-docs is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add ainiaa/skills-project-docs/project-docs-api@git:20261103.159a85e

Pins git:20261103.159a85e in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
ainiaa/skills-project-docs
Path
skills/project-docs-api/SKILL.md
Versions recorded
3
Latest version
git:20261103.159a85e, committed Nov 3, 2026
First version recorded
Oct 15, 2026
Size
7,356 bytes
Repository stars
4
License
Apache-2.0

Generate API documentation from Java Spring MVC, Feign, or Python FastAPI source, without IntelliJ IDEA. Use when asked for Markdown, Postman collections, or cURL examples from routes and request/response declarations.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Project Docs API

按[读者与用途约定](../../references/audience.md)提供必要解读;生成文档及用户要求的逐字接口片段仍保持下方契约,不能因读者不同改字段、必填、枚举或示例。读者提示放交付回复,独立解读按需提供,不重写生成原文。

Generate documentation with the API Savior RESTful Markdown contract from controller/Feign mapping annotations and real DTO declarations. Resolve this skill directory to its real path before using shared scripts or references, including when installed through a symlink. Use Python 3.11 or newer:

```bash
python3 <resolved-skill-directory>/../../scripts/generate_api_docs.py \
  --source <java-source-root> --output <output-directory> --base-url <optional-base-url>
```

It writes `api-docs.md`, `postman-collection.json`, and `curl.sh`.

- Pass one or more source roots with repeated `--source`.
- The generator is organized as `language adapter → API document IR → renderer`. `java_spring_adapter.py` and `python_fastapi_adapter.py` read source declarations; `api_document_renderers.py` consumes only the language-neutral IR. `generate_api_docs.py` preserves the CLI and existing Python imports. Use `--language python` for FastAPI source. See [the IR contract](../../references/api-document-ir.md) before adding another language or framework.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add ainiaa/skills-project-docs/project-docs-api@sha256:f5bb7d288231587c

The line at the top of this page pins the label git:20261103.159a85e, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_gvavdp23d3kzu54s.svg)](https://markdownregistry.com/a/art_gvavdp23d3kzu54s)

0 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 3 versions of this file, between Oct 15, 2026 and Nov 3, 2026, about one every 10 days.

versioncommittedcommitsizeaudit
git:20261103.159a85e latest2026-11-03 159a85e 7,356 BA view · diff
git:20261027.aaa6c552026-10-27 aaa6c55 7,064 BA view · diff
git:20261015.789b97f2026-10-15 789b97f 6,975 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (7356 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

ainiaa/skills-project-docs · 4 stars · license Apache-2.0 · pushed 2026-11-04 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_gvavdp23d3kzu54s
GET https://markdownregistry.com/api/v1/resolve?ref=ainiaa/skills-project-docs/project-docs-api
GET https://markdownregistry.com/api/v1/blob/f5bb7d288231587c4d2f4b5d867b9ec802a09882640f39739012ec82dcba9358

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from ainiaa/skills-project-docs

project-docs-diagram SKILL.md skill
ainiaa/skills-project-docs · skills/project-docs-diagram/SKILL.md · Create technical diagrams from repository evidence or a system description, and validate/export Mermaid, PlantUML…
git:20261103.159a85e · audit A · 4 stars
project-docs-lifecycle SKILL.md skill
ainiaa/skills-project-docs · skills/project-docs-lifecycle/SKILL.md · 围绕同一业务目标协调从痛点诊断、需求决策、设计研发、测试与业务验收到发布及效果跟踪,维护版本、证据和跨角色交接;适用于跨阶段推进或已有需求中途接续。仅写 PRD、接口文档或图时使用对应专用 Skill。
git:20261103.159a85e · audit A · 4 stars
project-docs-overview SKILL.md skill
ainiaa/skills-project-docs · skills/project-docs-overview/SKILL.md · 从代码和资料生成可追溯的项目、功能、架构和上手文档;按需用 Archify explainer 或零基础图解 HTML,帮助不同背景的读者理解概念、业务规则、技术机制、问题、方案取舍及变更影响。
git:20261103.159a85e · audit A · 4 stars
project-docs-product SKILL.md skill
ainiaa/skills-project-docs · skills/project-docs-product/SKILL.md · 用户要梳理业务需求、创建或修订 PRD、评审产品需求,或同时交付可点击 HTML 原型时使用;支持口述、纪要、业务资料和已有系统增量改造。项目现状说明走 project-docs-overview。
git:20261103.159a85e · audit A · 4 stars
project-docs SKILL.md skill
ainiaa/skills-project-docs · skills/project-docs/SKILL.md · 项目文档 Skill 集合的统一入口;当用户点名 project-docs、安装或升级本集合,协调从业务痛点到上线的跨阶段工作,或要组合交付产品 PRD、交互 HTML 原型、项目说明、接口文档与技术图时使用。
git:20261103.159a85e · audit A · 4 stars

Every file in ainiaa/skills-project-docs

Browse by kind, by grade A, or by owner.