Przejdź do treści
Biblioteka skilli
Programowanie · Planowanie

api-first-design-contract-evolution

/api-first-design-contract-evolution

Ustala procesy projektowania API najpierw kontraktem i bezpiecznie rozwija kontrakty, by nie łamać klientów.

Licencja
MIT
Ostatnia zmiana repozytorium
28.10.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 28.10.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

Ustala procesy projektowania API najpierw kontraktem i bezpiecznie rozwija kontrakty, by nie łamać klientów.

Oryginalny opis (EN)

Use this skill when standardizing API-first engineering workflows and evolving contracts safely without breaking consumers.

Jak działa

  1. When to use
  2. Prerequisites
  3. Step-by-step workflow
  4. Commands / code examples
  5. Common mistakes & pitfalls
  6. Verification checklist
  7. Related skills
Sekcje z nagłówków SKILL.md, w oryginale · 39 linii, 239 słów
Podgląd SKILL.md
---
name: api-first-design-contract-evolution
description: Use this skill when standardizing API-first engineering workflows and evolving contracts safely without breaking consumers.
---
# API-First Architecture & Contract Evolution

## When to use
Use this skill when you need to standardizing API-first engineering workflows and evolving contracts safely without breaking consumers.

## Prerequisites
- Deep familiarity with relevant domain standards, developer tooling, or testing frameworks.
- Access to testing repository, mobile simulator, or operational workspace.

## Step-by-step workflow
1. **Analyze requirements and constraints**: Review code quality gates, mobile runtime targets, or architecture patterns.
2. **Design implementation strategy**: Draft explicit interfaces, test cases, or declarative configurations.
3. **Execute implementation**: Build and integrate components according to domain best practices.
4. **Validate correctness**: Run automated test suites, verify build outputs, and inspect diagnostic logs.
5. **Establish maintenance guardrails**: Configure CI/CD quality checks, alerts, and documentation.

## Commands / code examples
```bash
# Operational command and verification workflow for api-first-design-contract-evolution
echo "Executing verification check for api-first-design-contract-evolution"
```

## Common mistakes & pitfalls
- Bypassing automated testing or linting checks under delivery pressure.
- Neglecting to isolate side effects, leading to flaky tests or fragile architectures.
- Introducing tight coupling between distinct architectural domains or deployment units.

## Verification checklist
- [ ] Implementations adhere strictly to domain conventions and standards.
- [ ] Automated verification passes cleanly with zero warnings or errors.
- [ ] Edge cases, error paths, and resource lifecycles are explicitly handled.
- [ ] Documentation and architectural decision records are updated.

## Related skills
- unit-testing-principles-aaa-pattern
- domain-driven-design-bounded-contexts
- ci-cd-github-actions-workflows
- git-interactive-rebase-squash-clean-history

Wersje

W bazie nie ma innych skilli o nazwie api-first-design-contract-evolution.

Migawka bazy z 13.11.2026 · wersja paczki 37cebc724659 (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

  • 90api-contracts
    Projektuje lub zmienia kontrakt API dla nowych i istniejących klientów: endpointy, schematy, błędy, uwierzytelnianie i wersjonowanie.
  • 100api-versioning-evolution-strategies
    Pomaga bezpiecznie wprowadzać zmiany łamiące kompatybilność w API dzięki wersjonowaniu w ścieżce, nagłówku i parametrze zapytania.
  • 100generating-api-contracts
    Generuje kontrakty API i specyfikacje OpenAPI z kodu lub dokumentów projektowych.
  • 100generating-api-contracts
    Generuje kontrakty API i specyfikacje OpenAPI z kodu lub dokumentów projektowych.
  • 100api-design
    Projektuje i przegląda API REST i GraphQL: modelowanie zasobów, kody statusu, kontrakty błędów, paginacja, wersjonowanie i ewolucja.
  • 90compatibility-design
    Planuje zmiany niezgodne wstecz, migracje i wycofywanie funkcji API, zachowując obsługę starszych wersji.

Uwagi i zgłoszenia

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