# Api Design

> >

- **Type:** Skill
- **Install:** `agentstack add skill-omnigentx-jarvis-api-design`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [omnigentx](https://agentstack.voostack.com/s/omnigentx)
- **Installs:** 0
- **Category:** [Agent Skills](https://agentstack.voostack.com/c/agent-skills)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [omnigentx](https://github.com/omnigentx)
- **Source:** https://github.com/omnigentx/jarvis/tree/main/backend/.fast-agent/skills/api-design

## Install

```sh
agentstack add skill-omnigentx-jarvis-api-design
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

# API DESIGN

## Workflow

1. **Identify use cases** from the BRD.
2. **Pick a pattern**: REST / WebSocket / gRPC.
3. **Define endpoints**.
4. **Write schemas** (request/response types).
5. **Document** error codes and edge cases.

## REST API template

```markdown
### [METHOD] /api/v1/resource

**Description**: what it does

**Request**:
- Headers: `Authorization: Bearer `
- Body:
  ```json
  { "field": "type", "description": "..." }
  ```

**Response 200**:
```json
{ "data": {...}, "message": "success" }
```

**Error codes**:
| Code | Meaning |
|------|---------|
| 400  | Invalid request |
| 401  | Unauthorized |
| 404  | Not found |
```

## Rules
- Endpoint paths use plural nouns (`/users`, not `/user`).
- Versioning lives in the URL (`/api/v1/`).
- Always use a single, consistent error-response shape.
- Paginate list endpoints (`?page=1&limit=20`).

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [omnigentx](https://github.com/omnigentx)
- **Source:** [omnigentx/jarvis](https://github.com/omnigentx/jarvis)
- **License:** MIT

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** yes
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-omnigentx-jarvis-api-design
- Seller: https://agentstack.voostack.com/s/omnigentx
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.