@sankhyalabs/fintech-spectral-rules

Fintech Spectral Rules

Este pacote contém um conjunto de regras personalizadas do contexto Sankhya FinTech para validação de documentação OpenAPI utilizando o Spectral. Ele estende as regras do pacote @stoplight/spectral-documentation e adiciona verificações específicas para garantir a qualidade da documentação.

📌 Instalação

Para utilizar este pacote em seu projeto, instale via npm:

npm install @sankhyalabs/fintech-spectral-rules --save-dev

🚀 Uso

No arquivo .spectral.yaml do seu projeto, estenda este pacote para aplicar as regras personalizadas:

extends:
  - "@sankhyalabs/fintech-spectral-rules"

Agora, execute o Spectral para validar sua API OpenAPI:

spectral lint openapi.yaml

Se preferir rodar o Spectral sem um arquivo .spectral.yaml, passe o pacote diretamente na linha de comando:

spectral lint --ruleset @sankhyalabs/fintech-spectral-rules openapi.yaml

📜 Regras Customizadas

O pacote adiciona regras extras para garantir a qualidade da documentação. Algumas delas incluem:

• snk-schema-properties-must-have-description-and-example → Todos os atributos dos schemas devem ter description e example.
• snk-endpoint-must-have-summary-and-description → Todos os endpoints devem conter summary e description.