Español | Spanish
Este repositorio contiene la documentación de la API RESTful 'Fake Rubik Store'. 'Fake Rubik Store' es un proyecto full stack que incluye un e-commerce de cubos de rubik. Esta API RESTful proporciona los servicios backend para la tienda online.
Inglés | English
This repository contains the documentation for the RESTful API called 'Fake Rubik Store API'. 'Fake Rubik Store' is a full stack project where I've built an e- commerce focused on Rubik's Cubes. This RESTful API provides the backend services for the online store.
Español | Spanish
- Introducción:
- Objetivo del proyecto
- Público objetivo
- Alcance de la API
- Guía del Desarrollador:
- Configuración del entorno
- Autenticación
- Métodos HTTP soportados
- Entidades:
- Descripción detallada de cada - entidad (usuario, producto, etc.)
- Propiedades y tipos de datos
- Endpoints:
- Lista completa de endpoints
- Descripción detallada de cada - endpoint
- Parámetros de consulta
- Cuerpo de la solicitud (body)
- Respuestas posibles (códigos de estado HTTP y formato de datos)
- Limitaciones
Inglés | English
- Introduction:
- Project goals
- Target audience
- API scope
- Developer guide:
- Configuration environment
- Authentication
- Methods HTTP supported
- Entities:
- Detailed description about any entity (Products, Users, etc.)
- properties and data types
- Endpoints:
- Completed list of endpoints
- Detailed description about every endpoints
- Query params
- Request body
- response possible (HTTP status code and data format)
- Limitations
Español | Spanish Actualmente este proyecto se encuentra en su primera versión, y progresivamente se le añadirán mas funcionalidades. La documentación se encuentra en desarrollo y aún no está disponible en producción.
Inglés | English Actually this project is in first version, and I will progresively adding new features. Documentation is currently under development and it isn't avalible in production.