Cómo escribir un documento de interfaz java

Algunos estudiantes del lado del servidor que recién comienzan a escribir documentos de interfaz tienden a escribir documentos de interfaz basados ​​​​en ideas de código. Esto hace que los estudiantes del lado del cliente o el personal técnico del servicio de acoplamiento a menudo se quejen de que no pueden entender los documentos de la interfaz. . Este artículo proporciona un método para escribir documentos de interfaz generales para su referencia.

Se recomienda utilizar docway para escribir documentos de interfaz, lo cual es conveniente para guardar y compartir. Admite la exportación de PDF MARKDOWN y admite la gestión de proyectos en equipo.

1. Parámetros de solicitud

1. Método de solicitud

GET

Se utiliza para obtener datos

POST<. /p>

Se usa para actualizar datos, intercambiable con PUT, semánticamente PUT admite idempotencia

PUT

Se usa para agregar nuevos datos, intercambiable con POST, semánticamente, PUT admite idempotencia

DELETE

para eliminar datos

Otros

Otros métodos de solicitud son muy comunes en las interfaces generales. Úselo con moderación. Por ejemplo: OPCIONES DE PATCH HEAD

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 la identificación se utiliza como parámetro.

3. Encabezado HTTP

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

Tipo de contenido de uso común:

aplicación/x-www-form-urlencoded

Los parámetros de solicitud utilizan una conexión simbólica "amp;".

application/json

El contenido está en formato json

application/xml

El contenido está en formato xml

multipart /form-data

El contenido se compone de varios datos, separados por delimitadores

4. Cuerpo HTTP

Descripción (anteriormente llamado Xiaoyaoji) La documentación de Write Interface es conveniente para guardar y compartir, admite la exportación de PDF MARKDOWN y admite la gestión de proyectos en equipo.