Manual de diseño de la interfaz API del segundo sistema Kill
1. Introducción
1.1 Propósito de la escritura
El proyecto adopta la tecnología de separación del front-end y el back-end. El propósito de escribir el manual del sistema es aclarar mejor las funciones del sistema y realizar un desarrollo estandarizado. Al mismo tiempo, es un documento de referencia importante para la integración del front-end y el back-end. back-ends y posterior aceptación del proyecto.
1.2 Antecedentes
Este manual de diseño de interfaz API describe el sistema seckill.
2 Resumen
2.1 Parámetros de salida unificados
Tabla 2-1 Información del parámetro de respuesta
Si se debe describir el tipo de nombre del parámetro code int es el código de estado msg String son los datos del mensaje de devolución T no es información de devolución
Nota: T es genérico significa cualquier tipo
2.2 Interfaces que deben iniciar sesión para acceder
Tabla 2-2 Iniciar sesión para acceder a la interfaz
Descripción del nombre de la interfaz/miaosha/do_miaosha función seckill
2.3 Lista de códigos de retorno de error
Tabla 2-3 Lista de códigos de retorno de error
mensaje de código 500100 Excepción del servidor 500101 Excepción de verificación de parámetros: %s 500210 La sesión no existe o ha caducado 500211 La contraseña de inicio de sesión no puede estar vacía 500212 El número de teléfono no puede estar vacío 500213 Error de formato del número de teléfono 500214 El número de teléfono no existe 500215 Error de contraseña 500216 El código de verificación es Vacío 500217 Error de código de verificación 500500 El producto se ha vendido en segundos 500501 No se puede repetir en segundos
Nota: El backend de %s se completará automáticamente y el frontend recibirá una cadena completa como: "Excepción de verificación de parámetros: el formato del número de teléfono móvil es incorrecto".
3 interfaz de usuario
3.1 Inicio de sesión de usuario
Acceso: /login/do_login
Descripción: inicio de sesión de usuario
Suma de comprobación: sesión
Método: obtener/publicar
Tabla 3-1 Parámetros de solicitud de inicio de sesión de usuario
Si se debe describir el tipo de nombre del parámetro mobile Cadena es el número de teléfono móvil contraseña Cadena es la contraseña verificarInput Cadena sin código de verificación ifyzm int no si se requiere código de verificación
Nota: cuando ifyzm es 0, debe completar el código de verificación, cuando ifyzm es 1, no necesita completar el código de verificación
Tabla 3-2 Parámetros de respuesta de inicio de sesión del usuario
Si se debe describir el tipo de nombre del parámetro código int es el código de estado msg Cadena son los datos del mensaje de retorno booleano es si el inicio de sesión fue exitoso
Una vez que el inicio de sesión sea exitoso, el token se devolverá y se registrará en la cookie.
4 interfaz de productos básicos
4.1 Interfaz de lista de productos
Interfaz: /bienes/a_lista
Descripción: Lista de productos
Suma de comprobación: sesión
Método: obtener/publicar
Requst no necesita pasar parámetros, devuelve información de la lista de productos y transfiere datos a través del Modelo a la Lista de Productos
Tabla 4-1 Parámetros de respuesta de la lista de productos
Si el tipo de nombre de parámetro debe describir mercancíasList Lista<GoodsVo> es la información de la lista de productos mercancías. mercancíasNombre Cadena es el nombre del producto mercancías. mercancíasImg Cadena es la foto del producto mercancías. mercancíasPrice Double es el precio del producto mercancías. miaoshaPrice Double es el precio de venta flash bienes.stockCount Integer es el stock de bienes .id Long es la identificación del producto
4.2 Interfaz de detalles del producto
Interfaz: /bienes/to_detail/{goodsId}
Descripción: detalles del producto
Suma de comprobación: sesión
Método: obtener/publicar
Tabla 4-2 Parámetros de solicitud de detalles del producto
Si el tipo de nombre del parámetro debe describir mercancíasId largo es la identificación del producto
Devolver información detallada del producto y transferir datos a través del modelo a los bienes
Tabla 4-3 Parámetros de respuesta de detalles del producto
Si el tipo de nombre de parámetro debe describir mercancías.startDate La fecha es la hora de inicio de la selección de mercancías. mercancíasNombre Cadena es el nombre del producto mercancías. mercancíasImg Cadena es la foto del producto mercancías. bienesPrice Double es el precio original de las mercancías. miaoshaPrice Double es el precio de seckill de bienes.stockCount Integer es el stock de bienes .id Long es el id del producto miaoshaStatus int es el segundo estado de eliminación restanteSeconds int es la cuenta regresiva de la segunda eliminación
Nota: El estado de seckill: 0 significa que aún no ha comenzado, 1 significa que está en progreso y 2 significa que el seckill ha terminado.
5 interfaz de selección
5.1 pico
Acceso: /miaosha/do_miaosha
Descripción: pico
Suma de comprobación: sesión
Método: obtener/publicar
Tabla 5-1 Parámetros de solicitud de detalles del producto
Si el tipo de nombre del parámetro debe describir mercancíasId largo es la identificación del producto
Devuelva la información del pedido y la información del producto una vez finalizada la selección y transfiera los productos y los datos de información del pedido a través del Modelo.
Tabla 5-2 Parámetros de respuesta de inicio de sesión del usuario
Si el tipo de nombre de parámetro debe describir los productos.goodsName Cadena es el nombre del producto productos.goodImg Cadena es la foto del producto orderInfo.goodsPrice Double es el precio del pedido orderInfo.createDate Fecha es la hora del pedido orderInfo.status Entero es el estado del pedido
Nota: Estado del pedido: 0 impago, 1 en espera de envío, 2 enviado, 3 recibido, 4 reembolsado, 5 completado