Cómo escribir una interfaz API

Cuando algunos estudiantes del lado del servidor comenzaron a escribir documentos de interfaz, era fácil escribir documentos de interfaz de acuerdo con la idea del código. Esto hizo que los estudiantes del cliente o el personal técnico del lado del servidor a menudo se quejaran de eso. no podían entender los documentos de la interfaz. Este artículo proporciona un método de redacción de documentos de interfaz convencional para su referencia.

¿Recomendable utilizar docway? Escriba documentos de interfaz para guardarlos y disfrutarlos fácilmente, admita la exportación de PDF MARKDOWN y admita la gestión de proyectos del equipo.

I.Parámetros de solicitud

1. Método de solicitud

GET

Obtener datos

POST

Actualizar datos, intercambiables con PUT, PUT semánticamente admite idempotencia

PUT

Agregar nuevos datos, intercambiables con POST, PUT semánticamente admite idempotente

DELETE

Eliminar datos

Otros

Otros métodos de solicitud rara vez se utilizan en interfaces generales. Por ejemplo, PATCH HEAD OPTIONS

2.URL

url representa la ruta de solicitud de la interfaz. La ruta puede contener parámetros, llamados parámetros de dirección, como **/usuario/{id}**, donde se utiliza id como parámetro.

3. Encabezado HTTP

El encabezado HTTP se utiliza para proporcionar información básica de la solicitud. Esta información se presentará en el documento de interfaz en formato K-V, del cual Content-Type es un. Encabezado muy necesario, utilizado para describir el tipo de datos del cuerpo de la solicitud.

Tipos de contenido más utilizados:

aplicación/x-www-form-urlencoded

Los parámetros de solicitud se conectan mediante el símbolo "&".

aplicación/json

Contenido en formato Json

aplicación/xml

contenido en formato xml

multiparte /formulario -data

El contenido consta de varios datos, separados por delimitadores

4. Cuerpo HTTP

Descripción (anteriormente conocida como Little Missy) escribe documentos de interfaz, que son fáciles de guardar. y * *** Disfrute, admita la exportación de PDF MARKDOWN y apoye la gestión de proyectos del equipo.