Przejdź do treści
Biblioteka skilli
Programowanie · Planowanie

rest-api-design

/rest-api-design

Projektuje RESTful API z właściwym nazewnictwem zasobów, metodami HTTP, kodami statusu i formatami odpowiedzi, z myślą o wygodzie programistów.

Repozytorium
claude-skills ↗
Licencja
MIT
Ostatnia zmiana repozytorium
26.09.2026

Ocena i bezpieczeństwo

100/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
1
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 26.09.2026, bez odwołań do wycofanych modeli i API.

Licencja

MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.

Co robi i kiedy

Projektuje RESTful API z właściwym nazewnictwem zasobów, metodami HTTP, kodami statusu i formatami odpowiedzi, z myślą o wygodzie programistów.

Oryginalny opis (EN)

Designs RESTful APIs with proper resource naming, HTTP methods, status codes, and response formats. Use when building new APIs, establishing API conventions, or designing developer-friendly interfaces.

Jak działa

  1. Resource Naming
  2. HTTP Methods
  3. Status Codes
  4. Response Format
  5. Collection Response
  6. Query Parameters
  7. Best Practices
Sekcje z nagłówków SKILL.md, w oryginale · 98 linii, 289 słów
Podgląd SKILL.md
---
name: rest-api-design
description: Designs RESTful APIs with proper resource naming, HTTP methods, status codes, and response formats. Use when building new APIs, establishing API conventions, or designing developer-friendly interfaces.
license: MIT
---

# REST API Design

Design RESTful APIs with proper conventions and developer experience.

## Resource Naming

```
# Good - nouns, plural, hierarchical
GET    /api/users
GET    /api/users/123
GET    /api/users/123/orders
POST   /api/users
PATCH  /api/users/123
DELETE /api/users/123

# Bad - verbs, actions in URL
GET    /api/getUsers
POST   /api/createUser
POST   /api/users/123/delete
```

## HTTP Methods

| Method | Purpose | Idempotent |
|--------|---------|------------|
| GET | Read resource | Yes |
| POST | Create resource | No |
| PUT | Replace resource | Yes |
| PATCH | Partial update | Yes |
| DELETE | Remove resource | Yes |

## Status Codes

| Code | Meaning | Use For |
|------|---------|---------|
| 200 | OK | Successful GET, PATCH |
| 201 | Created | Successful POST |
| 204 | No Content | Successful DELETE |
| 400 | Bad Request | Validation errors |
| 401 | Unauthorized | Missing auth |
| 403 | Forbidden | Insufficient permissions |
| 404 | Not Found | Resource doesn't exist |
| 429 | Too Many Requests | Rate limited |

## Response Format

```json
{
  "data": {
    "id": "123",
    "type": "user",
    "attributes": {
      "name": "John",
      "email": "john@example.com"
    }
  },
  "meta": {
    "requestId": "req_abc123"
  }
}
```

## Collection Response

```json
{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  },
  "links": {
    "self": "/api/users?page=1",
    "next": "/api/users?page=2"
  }
}
```

## Query Parameters

```
GET /api/products?category=electronics    # Filtering
GET /api/products?sort=-price,name        # Sorting
GET /api/products?page=2&limit=20         # Pagination
GET /api/products?fields=id,name,price    # Field selection
```

## Best Practices

- Use nouns for resources, not verbs
- Version API via URL path (`/api/v1/`)
- Return appropriate status codes
- Include pagination for collections
- Document with OpenAPI/Swagger

Wersje

RepozytoriumWynikLicencja
Ta strona · secondsky/claude-skills100MIT
curiositech/windags-skills100Apache-2.0
sudeeppatgar/fullstack-skills100MIT
curiositech/some_claude_skills100MIT

Migawka bazy z 13.11.2026 · wersja paczki 6f17a0330aa6 (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 100api-design
    Projektuje API RESTful z modelowaniem zasobów, semantyką metod HTTP, kodami statusu, paginacją, wersjonowaniem i dokumentacją.
  • 100restful-api-design-best-practices
    Pomaga projektować i porządkować REST API według zasad modelowania zasobów, kodów statusu i konwencji JSON.
  • 100api-design
    Generuje projekty API REST i GraphQL ze specyfikacjami OpenAPI, nazewnictwem zasobów, kodami statusu, paginacją, filtrowaniem, błędami i wersjonowaniem.
  • 95rest-api-designer
    Projektuje endpointy REST: modelowanie zasobów, metody HTTP i strukturę adresów URL.
  • 100api-design
    Podaje standardy projektowania RESTful API: nazwy zasobów, metody HTTP, kody statusu, paginacja i wersjonowanie, kształt odpowiedzi błędów i filtrowanie.
  • 100rest-api
    Opisuje zasady projektowania REST API: zasoby, metody i kody statusu, przy projektowaniu lub przeglądzie API.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.