¿Qué debe incluir un documento de interfaz estandarizado?
¿Qué es un documento de interfaz?
En el desarrollo de proyectos, el front-end y el back-end del proyecto web se desarrollan por separado, y el desarrollo de aplicaciones requiere front-end y back-end. Los ingenieros finales definen conjuntamente la interfaz y escriben el documento de interfaz.
Después de eso, todos desarrollarán de acuerdo con este documento de interfaz y se mantendrá hasta el final del proyecto.
¿Por qué escribir documentos de interfaz?
1. Durante el proceso de desarrollo del proyecto, los ingenieros de front-end y back-end tienen un archivo unificado para la comunicación y el desarrollo.
2. Durante el mantenimiento del proyecto o cuando el personal del proyecto cambia, es conveniente para que el personal posterior la vea y mantenga
3. Evitar algunas tareas que no deberían ser suyas y que se le impongan a usted mismo, etc.
¿Qué debe contener el documento de interfaz?
Acuerdo, (por ejemplo, qué métodos se deben utilizar para operar los recursos)
Título claro y claro, qué función en el diagrama del prototipo implementa esta interfaz.
URL: URL de estilo resto y tiene una identidad unificada
Tipo de solicitud: GET PUT POST DELETE
Responsable de front-end y back-end
Parámetros de solicitud
Parámetros de retorno
Estado de finalización de la interfaz
¿Cuáles son las especificaciones de los documentos de la interfaz?
URL: comenzando con /a, si necesita iniciar sesión para llamar a la interfaz (como nuevas incorporaciones, modificaciones; información personal del usuario en la recepción, información del fondo, etc.), debe ir seguido de /u, es decir: /a/u; el nombre o una palabra que pueda expresar esta interfaz generalmente se coloca en el medio; si es una lista de consultas de backend a través de la búsqueda, termina con /search, si es la lista de consultas de frontend termina con /list; Los parámetros de URL no se mencionarán. No se permiten letras mayúsculas en la dirección uri. Si se unen dos palabras, use / para separarlas
Los parámetros de solicitud y los parámetros de devolución se dividen en 5 columnas: campo, descripción, tipo, comentarios. y si es obligatorio
Los campos son atributos de la clase, la descripción es la definición china y el tipo es el tipo de atributo, y solo hay cuatro tipos: Cadena, Número, Objeto y Matriz; los comentarios son algunas explicaciones, o puede escribir ejemplos, como los responsables de la estructura json. Es mejor escribir un ejemplo para que la interfaz pueda comprender mejor la situación si el campo es obligatorio o no; requerido.
Hay varias situaciones en las que se devuelve la estructura de parámetros: 1. Si solo se devuelve el éxito o el fracaso de la llamada de la interfaz (como agregar, eliminar, modificar, etc.), solo hay una estructura: dos parámetros: código y mensaje; 2 Si desea devolver algunos parámetros, hay dos estructuras: 1 es código/mensaje/datos, 2 son los parámetros devueltos escritos en datos, los datos son de tipo objeto; desea devolver una lista, entonces hay tres estructuras, 1 es código/mensaje/datos, los datos son objetos y los 5 parámetros página/tamaño/total/página total/lista se colocan en él, donde la lista es de tipo Array, El objeto se coloca en la lista y el objeto es el parámetro específico.
¿Cuál es el estándar para medir documentos de interfaz?
Gracias por ver
Eso es todo para compartir hoy. Todos pueden dar me gusta, volver a publicar y dejar un comentario. mensaje y hacer ladrillos ~
Skill Tree.IT Cultivation Academy
"Creemos que todos pueden convertirse en ingenieros. A partir de ahora, busque un senior que lo ayude a comenzar y controlar su propio ritmo de aprendizaje. No más confusión en el camino”.
Este es Skill Tree. IT Cultivation Academy, donde miles de personas mayores han encontrado sus propias rutas de aprendizaje. El aprendizaje es transparente, el crecimiento es visible y las personas mayores brindan orientación personalizada. Ven y estudia conmigo~
www.jnshu.com/login/1/14708688