Sonar openapi – asyncapi
¿Qué son las sonar-rules?
Los proyectos de sonar-openapi-rules y sonar-asyncapi-rules son proyectos desarrollados para poder chequear tu openapi y generar un scoring tanto para APIs síncronas como asíncronas. Los proyectos que incluyen son:
- sonar-openapi-core: Proyecto core de parseo del openapi
- sonar-openapi-rules: Proyecto con más de 100 reglas implementadas
- sonar-asyncapi-core: Proyecto core para el parseo de asyncapi
- sonar-asyncapi-rules: Proyecto con las reglas implementadas para asyncapi
Tipos de reglas
Existen 3 tipos de reglas:
- Reglas orientadas a normalizar el diseño de las APIs (por ejemplo camelCase en los parámetros)
- Reglas de api security: Reglas de seguridad basada en definición, como validar que no introduzcan ids predecibles
- Reglas de buenas prácticas de openapi/asyncapi: Van destinadas a validar que se están desarrollando bien los documentos, como que se definan los schemas en las sección de componentes.
