Receber por email
← Voltar para o catálogo

api-contract-design

Projete APIs usando uma abordagem schema-first com OpenAPI/Swagger. Utilize ao criar novas APIs, documentar as existentes ou quando equipes de frontend e backend precisam trabalhar em paralelo, abrangendo especificação, validação e geração de código OpenAPI.

2estrelas
Atualizado há 4 meses

Ver no GitHub ↗

Como adicionar

/plugin marketplace add bg-szy/TOP-SKILLS

O comando exato pode variar conforme o repositório. Confira o README no GitHub.

Para o autor da skill

Cole no README do seu repo

Mostra que sua skill está catalogada na Skillteca, gera backlink e tráfego rastreável.

[![Skillteca](https://www.skillteca.com.br/api/badge/api-contract-design-bg-szy/svg)](https://www.skillteca.com.br/skills/api-contract-design-bg-szy)

Alerta por categoria

Receba novas skills de Design e Frontend toda segunda

1 email curto, só com as skills novas de Design e Frontend. 4 minutos de leitura, sem spam, cancela com 1 clique.

Você confirma o email no primeiro envio. Sem spam. Cancela com 1 clique.

Ler descrição completa

API Contract Design

OpenAPI(Swagger) 기반 스키마 우선 API 설계 스킬입니다.

Core Principle

"코드보다 계약(Contract)이 먼저다."
"프론트엔드와 백엔드가 동시에 개발할 수 있게 API를 먼저 정의한다."

Schema-First vs Code-First

| 접근법 | 장점 | 단점 | |--------|------|------| | Schema-First (권장) | 병렬 개발 가능, 명확한 계약 | 초기 설계 시간 필요 | | Code-First | 빠른 시작 | 문서와 코드 불일치 위험 |

OpenAPI 기본 구조

openapi.yaml

openapi: 3.1.0
info:
  title: My API
  version: 1.0.0
  description: API for My Application

servers:
  - url: https:

[Description truncada. Veja o README completo no GitHub.]
Compartilhar X LinkedIn