hsCodes

DEFINICIÓN

REST APIs utilizan Uniform Resource Identifiers (URI) para direccionar los recursos. Los diseños de URIs bien hechos comunicarían claramente el recurso de la API, como por ejemplo:

http://example.restapi.es/france/paris/louvre/leonardo-da-vinci/mona-lisa

Un diseño incorrecto de los URIs daría un recurso mucho más difícil de entender como:

http://example.restapi.es/68dd0-a9d3-11e0-9f1c-0800200c9a66

La información de cada sección, cuando hablamos de REST, son los recursos. Por lo tanto, es la información a la que queremos acceder, modificar o eliminar, lo que sólo podemos hacer a través del primer ejemplo de URI mostrado.

FORMATO DE URI

La sintaxis del URI genérico se define como sigue:

URI = scheme "://" authority "/" path [ "?" query ] [ "#" fragment ]

Ejemplo de punto final con el estándar URI

• URI Scheme: El esquema identifica el protocolo de acceso a los recursos, puede ser HTTP (without SSL) or HTTPS (with SSL). Se compone del nombre del esquema seguido de dos puntos (“:”).

• Authority: Es el elemento jerárquico que identifica la autoridad de nomenclatura, está formado por el nombre de host y el puerto.

• Hostname: Es el identificador de una máquina dentro de una red que identifica el host que contiene el recurso.

• Port: Es un valor opcional que especifica el puerto en el que el host escucha las peticiones, el puerto por defecto de un servidor web es el 80.

• Path: Es la ruta que identifica el recurso específico en el host al que el cliente consumidor quiere acceder, separando la estructura jerárquica de los recursos con una barra (“/”).

• Section: En la jerarquía lógica de los recursos, éste sería el recurso padre.

• Sub-section: Es un hijo de recurso, directamente relacionado con un recurso paterno.

• Query: Es un componente opcionalque se incluye después de la ruta de acceso y tiene una estructura no jerárquica, y proporciona una cadena de información que el recurso puede utilizar para algún propósito, por ejemplo, para buscar parámetros o datos a procesar. La consulta suele ser una cadena de pares de parámetros y valores ("argumento=valor"). Los argumentos junto con los valores se separan entre sí con un ampersand ("&").

• Arguments: Son los parámetros que se utilizarán en la consulta, deben ir inmediatamente después de la ruta y comenzar con un signo de interrogación ("?").

• Values: Son los valoresque contienen los parámetros de la consulta.

• Fragment: El fragmento es un componente opcional que permite identificar una parte del recurso principal, o la vista de una representación del mismo. El comienzo de este componente se indica con el carácter de libra ("#").