Api And Interface Design

Community

thiientv

api-and-interface-design

Designs or reviews HTTP, REST, GraphQL, RPC, CLI, webhook, event, and service interfaces with explicit inputs, outputs, errors, compatibility, idempotency, pagination, authentication, versioning, and observability. Use when introducing or changing an API or cross-component contract. Not for internal implementation details with no boundary or for debugging one API failure; use root-cause-debugging there.

Overview

Publisher	thiientv
Repository	`godmode`
Skill name	`api-and-interface-design`
Stars	99
Forks	76
Bundled files	1
License	MIT
Links	Skill source Repository Homepage

Markdown instructions
A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.
Works with any LLM
AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.
1 bundled files
Scripts, templates, and references the model can read while it works. Files are read-only and never executed.
Open source
Published by thiientv on GitHub. Read the source before you install it.

Installation

Install the Api And Interface Design AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

Open the app and go to Plugins → Skills.
Choose "Install from GitHub".
Paste the skill folder URL below and confirm.
https://github.com/thiientv/godmode/tree/main/skills/api-and-interface-design
Enable the skill in any chat where you want it available.

Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills

git clone --depth 1 https://github.com/thiientv/godmode.git /tmp/godmode
mkdir -p .claude/skills
cp -r /tmp/godmode/skills/api-and-interface-design .claude/skills/api-and-interface-design

Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Api And Interface Design in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Api And Interface Design on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Api And Interface Design is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

Loaded only when it is needed
The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.
Switch models mid-chat
Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

API and Interface Design

Design the contract from the caller's failure modes, not only the happy path.

Establish the contract

Identify consumers, trust boundaries, lifecycle, latency expectations, and ownership.
Define request/command shape, response/event shape, status or error model, validation, defaults, and canonical examples.
Decide idempotency, retries, ordering, pagination, concurrency, rate limits, cancellation, and partial failure behavior.
Define authentication, authorization, sensitive fields, and audit needs.
Decide compatibility and versioning: additive change, migration, deprecation, or explicit breaking release.

Read contract-checklist.md for the review matrix. Keep the contract close to the owning schema or source of truth and generate clients/docs only when the repository already supports generation.

Implementation handoff

Write examples that can become contract tests. Include malformed input, missing resource, duplicate request, timeout, dependency failure, permission denial, and oversized input cases. Make error codes stable enough for callers and messages safe enough for logs and users.

Do not expose internal stack traces, persistence identifiers, or implementation details by accident. Do not add versioning machinery before a compatibility need exists.

Completion condition

Consumers can predict valid requests, successful and failed responses, retry behavior, compatibility impact, and the evidence that proves the boundary.

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

references/contract-checklist.md1 KB

Frequently asked questions

What does the Api And Interface Design AI skill do?

Why use Api And Interface Design on TypingMind?

Because you install it once and use it with any model. Api And Interface Design is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Api And Interface Design in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/thiientv/godmode/tree/main/skills/api-and-interface-design. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Api And Interface Design?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Api And Interface Design?

As many as you like. As long as a model supports skills, you can use Api And Interface Design with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Api And Interface Design AI skill free?

Yes. It is published on GitHub by thiientv under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Autoreview

openclaw

OrganizationPopular

Structured code review when explicitly requested, preferring OpenAI/Codex before Claude.

Claw Score

Audit or refresh OpenClaw maturity scorecard docs from root taxonomy, maturity scores, and QA evidence artifacts without using maintainer discrawl data or committed inventory reports.

Clawsweeper

Use for all ClawSweeper work: OpenClaw issue/PR sweep reports, repair jobs, cloud fix PRs, @clawsweeper maintainer mention commands, trusted ClawSweeper-reviewed autofix/automerge, GitHub Actions…

Control Ui E2e

Use when designing, testing, fixing, or extending the OpenClaw Control UI GUI, including UI stress-test galleries with feedback inputs, Vitest + Playwright end-to-end checks, mocked Gateway flows,…

Overview

Installation

Install in TypingMind

Install in another agent

Use it in TypingMind

Works with any AI model

Skill instructions

API and Interface Design

Establish the contract

Implementation handoff

Completion condition

Bundled files

Frequently asked questions

Related AI Skills

Set up your own AI workspace now