Referencia API

Para qué es esta página#

Utilice esta página como manual de cara a la máquina para la superficie activa UAIX REST. Traduce el catálogo actual, el descubrimiento, la hoja de ruta, el esquema, el registro, el ejemplo, el validador, el kit de adopción, OpenAPI, el intercambio simulado y las rutas del paquete de conformidad en una referencia de lanzamiento legible por humanos.

Cuando usarlo#

• Cuando un implementador desea la ruta base exacta y el inventario de rutas no locales REST.
• Cuando un creador de herramientas necesita solicitudes iniciales, el paquete de adopción, los límites del plan futuro y un documento OpenAPI en lugar de realizar ingeniería inversa en el sitio.
• Cuando un revisor de lanzamiento quiere verificar que la documentación pública, las rutas orientadas a las máquinas, los límites de la hoja de ruta y la evidencia del validador apuntan al mismo lanzamiento.

Ruta más rápida a través de la superficie viva.#

1. resolver el actual/wp-json/uaix/v1/catalogruta primero.
2. Obtenga un esquema o ejemplo deEsquemas, Registro, yEjemplos.
3. Tira lo publicadoKit de adopcióncuando necesita el paquete de incorporación reutilizable más corto.
4. Enviar una ejecución del validadorValidadoro el frente a la máquina/wp-json/uaix/v1/validateruta.
5. Utilice elPaquete de conformidadcuando esa ejecución debe viajar como evidencia de liberación más amplia.
6. Usar/wp-json/uaix/v1/roadmapcuando la automatización también necesita la actual frontera entre el futuro y el trabajo.

Mapa de clases de ruta#

• Rutas de descubrimiento GET:catálogo, descubrimiento, esquemas, registro, registro de campo, ejemplos, enlaces de transporte, canales de confianza, registro de errores, niveles de conformidad, hoja de ruta, OpenAPI, kit de adopción y rutas de paquetes de conformidad publican registros actuales legibles por máquina.
• Ejecución de rutas POST:Las rutas de validación e intercambio simulado aceptan el candidato JSON y deben tratarse como superficies de ejecución sin tienda, no como páginas de destino rastreables.
• Rutas de citación humana:Las páginas con prefijo local, como UAI-1, Validador, Kit de adopción, Paquete de conformidad, Hoja de ruta y Registro de cambios, son las páginas que un reclamo público debe citar cuando la prosa, los límites y los próximos pasos son importantes.
• Descargar formularios:Los paquetes JSON descargables son formularios convenientes de los mismos registros públicos, no de autoridades separadas.

Lo que publica esta pagina#

• Una referencia de cara a la máquina ruta por ruta.
• Ejemplos de solicitudes iniciales para descubrimiento, búsqueda de perfiles, validación, recuperación de paquetes de incorporación y resolución de hojas de ruta.
• La exportación actual OpenAPI 3.1 para la superficie REST en vivo.
• Enlaces directos a las páginas públicas canónicas que explican el mismo registro en prosa.

Llamadas iniciales a nivel de ruta#

Utilice los fragmentos públicos a continuación cuando desee el catálogo en vivo, el ejemplo y las llamadas del validador en curl, PowerShell, Python o TypeScript sin realizar ingeniería inversa en la superficie de la ruta.

curl -sS /wp-json/uaix/v1/catalog

const catalog = await fetch('/wp-json/uaix/v1/catalog').then((response) => response.json());

$catalog = json_decode(file_get_contents('/wp-json/uaix/v1/catalog'), true, 512, JSON_THROW_ON_ERROR);

catalog = requests.get('/wp-json/uaix/v1/catalog', timeout=10).json()

Referencia en vivo frente a la máquina#

Utilice la referencia a continuación como fuente pública actual para el diseño de rutas, llamadas iniciales y exportación OpenAPI.

Siguiente paso#

Continuar aKit de adopciónsi necesitas el paquete publicado de primera prueba,Paquete de conformidadSi necesita el paquete JSON reutilizable más amplio, ábralo/wp-json/uaix/v1/roadmapsi la automatización necesita el límite del trabajo futuro, o volver aValidadorcuando se ejecuta la siguiente tarea o se exporta una verificación de prueba concreta.