Especificación de la interfaz REST

Principios de diseño de URL de recursos

El estilo REST estipula que todos los recursos se ubican a través de un localizador de recursos unificado (URL). La URL RESTful del recurso utiliza la siguiente plantilla:

http( s)://ip:puerto/(rest)/{service-name}/{version}/{rest-convention}

Una URL completa consta de la entrada de la interfaz del servicio, identificación de la interfaz del servicio (resto). Consta del nombre del servicio {nombre-servicio}, el número de versión {versión} y la ruta del recurso dentro del servicio {convención-resto}. El identificador de la interfaz del servicio "/rest" no es un requisito obligatorio.

Por ejemplo: Obtener la información básica de todos los roles Información http://localhost:8086/rest/uam/v1/roles

Reglas Si la interfaz del servicio pertenece a un dominio fijo nombre, ip:puerto debe reemplazarse por el nombre de dominio.

Los nombres de los campos en la URL de la regla deben ser una combinación de letras minúsculas, números, guiones o subrayados en inglés de ancho medio, como "búsqueda por grupo". No se recomienda utilizar mayúsculas y minúsculas. nombrar.

La longitud de la URL de la regla debe ser inferior a 2083 caracteres; de lo contrario, el servidor devuelve un código de estado 414.

La URL de la regla no puede contener caracteres especiales de URL (estándar RFC1738), que son obligatorios. cuando se requieren caracteres especiales.

La URL de la regla no debe contener información sensible relacionada con las líneas rojas de seguridad de la empresa.

Se recomienda que el sitio web RESTful expuesto a WebUI utilice una plantilla:

http(s)://ip:port/(rest)/{website-name}/ui /{version} /{rest-convention}

Nota: Para mantener coherente el estilo de la interfaz externa del sistema, agregue "ui" entre {website-name} y {version} para indicar que la interfaz actual es la interfaz proporcionada por el sitio web.