Especificación del documento de interfaz activa

Basado en la gran era actual del front-end, para mí, que ha sido responsable del desarrollo back-end durante muchos años, lo más importante es proporcionar interfaces y documentos estables. Facilitar el acoplamiento de negocios con socios.

Las especificaciones de definición de estilo RestFul más utilizadas en la actualidad son Get y Post. Después de la introducción de RestFul, creo que hay muchas especificaciones de definición de interfaz. Sabrá cuál es la función al observar la dirección de la interfaz. Mira la columna Algunas especificaciones básicas.

El protocolo de comunicación entre la API y el usuario del cliente debe utilizar el protocolo HTTPS para garantizar la seguridad de la transmisión de datos interactiva.

En la medida de lo posible, la API debe implementarse bajo un nombre de dominio dedicado:

Si está seguro de que la API es muy simple y no se ampliará más, puede considerar colocándolo bajo el nombre de dominio principal: /api

/v{n}

1.

1. Debes ingresar el número de versión de la API en la URL.

2. Adopte múltiples versiones de API para que coexistan y lancen versiones gradualmente.

3. n representa el número de versión, que se divide en número entero y de punto flotante.

Entero: versión de función grande, como v1, v2, v3...

Puntos flotantes: funciones adicionales, como v1.1, v1.2, v2.1, v2.2...

4. Para API o servicios, mantenga hasta los 3 más detallados versiones de producción

La ruta también se denomina "punto final" y representa la URL específica de la API.

1. En la arquitectura RESTful, cada URL representa un recurso (recurso), por lo que la URL no puede tener verbos, solo sustantivos.

Los sustantivos utilizados a menudo corresponden a los nombres de las tablas de la base de datos

2. Las tablas de la base de datos suelen ser "conjuntos" de registros similares, por lo que los sustantivos en la API deben ser pluralizado.

Ejemplo: /v1/productos

/v1/usuarios

/v1/empleados

GET (SELECCIONAR): Leer del servidor Obtenga los recursos.

POST (Crear): Crea un nuevo recurso en el servidor.

PUT (UPDATE): Actualiza un recurso en el servidor (el cliente proporciona el recurso completo que ha cambiado).

ELIMINAR: Elimina un recurso del servidor.

Ejemplo:

GET /v1/products Obtener todos los productos

GET /v1/products/ID Obtener información sobre un producto específico

POST /v1/products Nuevos productos

PUT /v1/products/ID Actualizar información para un producto específico