api · v1.0 · 2026-07-20 · sha256 f84bc7daac769fbb

api v1.0A

Immutable. This exact content never changes and is served at /api/v1/blob/f84bc7daac769fbb.

---
name: api
description: Application programming interface.
license: MIT
metadata:
  author: vant
  version: "1.0"
---

# API

> Application programming interface.

---

## When To Use

- HTTP services
- REST/GraphQL
- External data

---

## What To Do

### 1. REST

| Method | What |
|--------|------|
| GET | Read |
| POST | Create |
| PUT | Replace |
| PATCH | Update |
| DELETE | Remove |

### 2. Request

```javascript
// Fetch
const res = await fetch('https://api.example.com/users')
const data = await res.json()

// Node
const axios = require('axios')
const res = await axios.get('https://api.example.com/users')
```

### 3. GraphQL

```graphql
query {
  user(id: 1) {
    name
    email
  }
}
```

### 4. Auth

| Type | Header |
|------|--------|
| Bearer | Authorization: Bearer token |
| Basic | Authorization: Basic base64(user:pass) |
| API Key | X-API-Key: key |

---

**Role**: API Developer  
**Input**: Endpoint  
**Output**: Data

> Programmable.