Cómo escribir documentos de referencia de interfaz

Algunos estudiantes de servidor que recién comienzan a escribir documentos de interfaz tienden a escribir documentos de interfaz basados ​​​​en ideas de código, lo que hace que los estudiantes de clientes o los técnicos de acoplamiento de servicio a menudo se quejen de que no pueden entender los documentos de interfaz. Este artículo proporciona un método para escribir documentos de interfaz generales para su referencia.

¿Recomiendas Docway? Escriba documentos de interfaz para guardarlos y * * * compartirlos fácilmente, admita la exportación de PDF MARKDOWN y la gestión de proyectos en equipo.

1. Parámetros de solicitud

1. Método de solicitud

Obtener

Se utiliza para obtener datos.

Publicar

Se utiliza para actualizar datos y es intercambiable con PUT y admite semántica idempotente.

Put

Se utiliza para agregar datos, intercambiable con POST, el PUT semántico admite idempotente.

Eliminar

se utiliza para eliminar datos.

Otros

Otros métodos de solicitud rara vez se utilizan en interfaces comunes. Por ejemplo, las opciones del encabezado del parche

2. Localizador uniforme de recursos

la URL indica la ruta de solicitud de la interfaz. La ruta puede contener parámetros llamados parámetros de dirección, como **/usuario/{id}**, donde id es un parámetro.

3.Encabezado HTTP

El encabezado HTTP se utiliza para la información básica de esta solicitud. Se muestra en el documento de interfaz en modo K-V, donde el tipo de contenido es muy necesario. encabezado Describe el tipo de datos del cuerpo de la solicitud.

Tipos de contenido comunes:

application/x-www-form-urlencoded

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

Aplicación/json

El contenido está en formato json

Aplicación/xml

El contenido está en formato xml

Datos de formulario/multiparte

El contenido consta de varios datos, separados por delimitadores.

Texto 4.HTTP

Descripción (anteriormente conocido como Xiaoyao Chicken) escribe documentos de interfaz para facilitar guardar y * * * compartir, y admite la exportación de PDF MARKDOWN y la gestión de proyectos en equipo.