creados documentos de datos de APIs

Alejandro CR · Alejandro CR · commit a34a80d41d7a · 2023-12-28T02:13:04.000-05:00
diff --git a/docs/api/library.md b/docs/api/library.md
@@ -0,0 +1,28 @@
+[volver al inicio](/readme.md)
+
+[volver a implementación](/docs/phases/implementation.md)
+
+# API librería
+
+A continuación se listan los datos recomendados para la especificación.
+
+<br>
+
+## Clase
+
+- Nombre
+- Descripción
+- Atributos
+- Métodos
+- Ejemplos de uso
+
+<br>
+
+## Función
+
+- Nombre
+- Descripción
+- Argumentos
+- Tipo de retorno
+- Excepciones lanzadas
+- Ejemplos de uso
diff --git a/docs/api/web.md b/docs/api/web.md
@@ -0,0 +1,57 @@
+[volver al inicio](/readme.md)
+
+[volver a implementación](/docs/phases/implementation.md)
+
+# API web
+
+A continuación se listan los datos recomendados para la especificación.
+
+<br>
+
+## Request
+
+- HTTP version
+- HTTP method
+- URL
+- Authorization method
+- Query parameters
+- Request headers
+- Request body
+    - none
+    - application/json
+    - application/octet-stream
+    - application/x-www-form-urlencoded
+    - multipart/form-data
+    - text/xml
+- Cookies
+
+<br>
+
+## Success response
+
+- Status code
+    - 200 (listar recursos o buscar un recurso)
+    - 201 (crear un recurso)
+    - 202 (ejecución asincrona iniciada con éxito)
+    - 204 (actualizar o eliminar un recurso)
+- Status message
+- Response headers
+- Response body
+- Cookies
+
+<br>
+
+## Error response
+
+- Status code
+    - 400 (falló en la validación de datos de la petición)
+    - 401 (acción sin autorización)
+    - 403 (acción prohibida)
+    - 404 (la ruta o el detalle del recurso no existe)
+    - 405 (método http no permitido)
+    - 409 (hubo un conflicto al procesar la petición)
+    - 500 (error interno del servidor)
+- Status message
+- Response headers
+- Response body
+- Cookies
