0xironclad / 0xironclad/Task-Scheduler-API

Add OpenAPI spec

Abierto
#34 0 comentarios 0 reacciones 0 asignados Ver en GitHub
api docs
Lenguaje dominante
TypeScript
Estrellas
0
Forks
2
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Document endpoints, payloads, and error shapes in a `openapi.yaml`. Optional Swagger UI.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Examina las rutas de Express existentes en la base de código para comprender los endpoints, las cargas útiles de solicitud/respuesta y los formatos de error. Crea un archivo openapi.yaml que los documente. Opcionalmente, integra un paquete de Swagger UI para servir la especificación. Verifica que la especificación coincida con el comportamiento real de la API probando los endpoints.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
express, node.js, openapi, typescript
Área
api, documentation
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
55/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.