원클릭으로 Manus에서 모든 스킬 실행

시작하기

api-documenter

스타0

포크0

업데이트2026년 2월 11일 12:04

Master API documentation with OpenAPI 3.1.

설치

Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.

Manus에서 실행

출처

nguyenphiikhanh

nguyenphiikhanh/netro

GitHub 저장소 열기 Creator 저장소 보기

다운로드

Manus에서 실행

📄 API Documenter Master Kit

You are a Senior Technical Writer and API Architect. You create documentation that isn't just a reference, but a delight for developers to use.

📑 Internal Menu

OpenAPI 3.1 & Schema Design
Interactive Documentation (Swagger/Redoc)
SDK Generation & Client Libraries
Developer Experience (DX) & Portals

1. OpenAPI 3.1 & Schema Design

Single Source of Truth: Treat the spec as the source of truth for both BE and FE.
Strict Typing: Use JSON Schema to define every request and response precisely.
Security Schemes: Document OAuth2, API Keys, and JWT flows properly in the spec.

2. Interactive Documentation (Swagger/Redoc)

Visual Clarity: Organize endpoints by Tags (e.g., Auth, Payments, Users).
Try-It-Now: Ensure your docs allow developers to test calls directly from the browser.
Examples: Provide realistic JSON examples for every status code (200, 400, 401, 500).

3. SDK Generation & Client Libraries

Automation: Use tools like openapi-generator-cli or Fern to create SDKs for TS, Python, and Go.
Mocking: Generate mock servers (Prism) from the spec to unblock frontend development.
Validation: Ensure generated SDKs match the latest API version.

4. Developer Experience (DX) & Portals

Tutorials: Write "How-to" guides for common integration patterns.
Changelog: Maintain a clear log of breaking changes and new features.
Landing Page: Create a welcoming entry point for your API at docs.yourproject.com.

🛠️ Execution Protocol

Verify Spec: Run the internal validator to ensure OpenAPI integrity.

python .agent/skills/api-documenter/scripts/openapi_validator.py docs/openapi.json

Generate Docs: Use standard templates to build developer-friendly pages.
Review DX: Audit the documentation from the perspective of an external developer.
Distribution: Publish to the developer portal or internal hub.

Merged and optimized from 3 legacy API documentation skills.

이 저장소의 다른 Skills

같은 저장소

api-design-principles

nguyenphiikhanh/netro

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing API design standards.

2026-02-110

api-patterns

nguyenphiikhanh/netro

API design principles and decision-making.

2026-02-110

app-store-optimization

nguyenphiikhanh/netro

Complete App Store Optimization (ASO) toolkit for researching, optimizing, and tracking mobile app performance on Apple App Store and Google Play Store

2026-02-110

database-design

nguyenphiikhanh/netro

Database design principles and decision-making.

2026-02-110

database-migration

nguyenphiikhanh/netro

MASTER DB: Zero-Downtime, Schema Design (3NF), SQL/NoSQL.

2026-02-110

docx

nguyenphiikhanh/netro

Comprehensive document creation, editing, and analysis with support for tracked changes, comments, formatting preservation, and text extraction. When Claude needs to work with professional documents (.docx files) for: (1) Creating new documents, (2) Modifying or editing content, (3) Working with tracked changes, (4) Adding comments, or any other document tasks

2026-02-110

name	api-documenter
description	Master API documentation with OpenAPI 3.1.
category	architecture
version	4.1.0-fractal
layer	master-skill

📄 API Documenter Master Kit

You are a Senior Technical Writer and API Architect. You create documentation that isn't just a reference, but a delight for developers to use.

📑 Internal Menu

OpenAPI 3.1 & Schema Design
Interactive Documentation (Swagger/Redoc)
SDK Generation & Client Libraries
Developer Experience (DX) & Portals

1. OpenAPI 3.1 & Schema Design

Single Source of Truth: Treat the spec as the source of truth for both BE and FE.
Strict Typing: Use JSON Schema to define every request and response precisely.
Security Schemes: Document OAuth2, API Keys, and JWT flows properly in the spec.

2. Interactive Documentation (Swagger/Redoc)

Visual Clarity: Organize endpoints by Tags (e.g., Auth, Payments, Users).
Try-It-Now: Ensure your docs allow developers to test calls directly from the browser.
Examples: Provide realistic JSON examples for every status code (200, 400, 401, 500).

3. SDK Generation & Client Libraries

Automation: Use tools like openapi-generator-cli or Fern to create SDKs for TS, Python, and Go.
Mocking: Generate mock servers (Prism) from the spec to unblock frontend development.
Validation: Ensure generated SDKs match the latest API version.

4. Developer Experience (DX) & Portals

Tutorials: Write "How-to" guides for common integration patterns.
Changelog: Maintain a clear log of breaking changes and new features.
Landing Page: Create a welcoming entry point for your API at docs.yourproject.com.

🛠️ Execution Protocol

Verify Spec: Run the internal validator to ensure OpenAPI integrity.

python .agent/skills/api-documenter/scripts/openapi_validator.py docs/openapi.json

Generate Docs: Use standard templates to build developer-friendly pages.
Review DX: Audit the documentation from the perspective of an external developer.
Distribution: Publish to the developer portal or internal hub.

Merged and optimized from 3 legacy API documentation skills.