skills.rest
truongnat
truongnatCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-ba

Generates business-facing API analysis artifacts covering documentation, mapping, assessment, testing, and readiness.

Updated Jul 28, 2026
Search Tags:#api testing#business analyst#api documentation#api analysis#integration assessment#api mapping#readiness checklist
One-click install
npx skills add https://github.com/truongnat/Restly --skill api-ba-truongnat
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-ba
Source: https://github.com/truongnat/Restly/tree/main/.agents/skills/api-ba
Command: npx skills add https://github.com/truongnat/Restly --skill api-ba-truongnat

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Business analysts working with partner or third-party APIs often lack a structured, business-facing way to document, map, assess, and validate APIs without writing full OpenAPI specs or risking invented endpoints. This Skill produces a single API_BA.md artifact per invocation, grounded strictly in cited sources. ## Core Features & Use Cases - Seven analysis modes: api-doc, api-map, api-assess, api-design, api-checklist, api-test, and api-readiness, each filling dedicated sections of a shared template. - Hard safety contract: never invents endpoints or fields, never copies secrets or tokens into artifacts, and never claims production readiness without evidence. - Structured deliverable: every run produces API_BA.md with executive summary, sources, risks, open questions, and handoff sections, plus mode-specific tables such as API-to-screen mappings and Pass/Fail/Unknown readiness gates. - Use Case: A BA evaluating a payment provider's API runs api-assess to compare build vs. integrate options, then api-readiness before go-live to verify auth, error contracts, and rollback plans with cited evidence. ## Quick Start Ask the agent to run api-ba in api-map mode using the partner API documentation URL to produce an API_BA.md mapping API fields to system data and screens.

Frequently Asked Questions about api-ba

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a business-facing summary of a partner API?▼

Run the api-doc mode with the partner's API documentation or spec as input. It produces an API_BA.md with a business summary table mapping capabilities to endpoints, business meaning, and limits, citing every source used.

How do I map API fields to screens and system data?▼

Use the api-map mode, which fills a mapping table with three layers: API field or resource, system data, and screen or UX. Every row must include all three layers, and unknown values are marked as assumptions rather than invented.

Can this skill generate API test cases for Bruno or Postman?▼

Yes, the api-test mode outlines executable test cases with method, path, data, and expected results, plus a collection structure for Bruno or Postman. It never pastes secrets or tokens into the artifact.

What does the API readiness check cover before go-live?▼

The api-readiness mode evaluates gates including docs completeness, auth verification, happy path, error contracts, monitoring, and rollback plan. Each gate is marked Pass, Fail, or Unknown with evidence, and no silent Pass is allowed.

What are the limitations of this API analysis approach?▼

It does not produce full OpenAPI rewrites unless explicitly asked, and it cannot proceed without source documentation since inventing endpoints is forbidden. When docs are missing, it confirms with the user first and records open questions.

Related Skills

Explore More Product & Management Skills→
angga30angga30

api-documenter

Author OpenAPI 3.1 and AsyncAPI specs and generate developer portals.

Community
Advanced
iusztinpauliusztinpaul
487

implement

Coordinate software-engineer and tester agents to implement and commit a single ticket.

Community
Advanced
ylxmf2005ylxmf2005
11

api-contract-tester

Verify live API endpoints against documented contracts and generate pass/fail test reports.

Community
Advanced
curiositechcuriositech
181

openapi-spec-writer

Generate OpenAPI 3.0/3.1 YAML or JSON specifications for REST APIs.

Official
Advanced