Descripción general

Schema, un concepto fundamental en OpenAPI Specification (OAS), también se conoce comúnmente como un modelo de datos. Un schema define los tipos de datos y las propiedades esperados de los objetos de petición y respuesta de la API.

JSON Schema sirve como el estándar adoptado por Apidog para modelar las estructuras de datos empleadas por su API.

Con schemas, usted puede:

Definir estructuras de datos estándar (como un objeto Order).

Integrar schemas con ejemplos generados automáticamente.

Aprovechar estructuras de datos repetidamente en todos sus proyectos de API.

Propósito de Schema en Apidog

Dentro de Apidog, los schemas desempeñan un papel fundamental en:

Propósito	Descripción
Diseñar APIs	Al definir schemas en una fase temprana del diseño, los desarrolladores pueden visualizar y perfeccionar las estructuras de datos que manejarán sus APIs.
Crear servicios mock	Apidog utiliza schemas definidos para generar respuestas mock, lo que permite a los desarrolladores simular el comportamiento de la API y la interacción con el front-end incluso antes de la implementación real.
Documentación	La documentación de API precisa y completa se genera automáticamente en función de los schemas, lo que facilita una comunicación clara con los consumidores de la API sobre los formatos y las estructuras de datos esperados.
Depuración	Los schemas se utilizan para validar las respuestas en la depuración de API, lo que garantiza que las respuestas de la API se ajusten a los modelos de datos definidos.

Crear un Schema

Considere el alcance de su schema: ¿Los datos se utilizarán en varias secciones de API o APIs, o son específicos de un único caso de uso?

Si la estructura de datos está destinada a varios usos, crear un schema facilita la gestión centralizada y la coherencia.

Puede agregar un schema en el directorio "Schemas".

Construir el Schema

Aproveche el editor de schemas fácil de usar de Apidog para construir schemas de forma eficaz que se ajusten a las especificaciones de JSON Schema.

También puede construir schemas importando desde tablas de base de datos o datos JSON/JSON schema.

Aplicar el Schema

Tras establecer un schema reutilizable, vaya a los endpoints para hacer referencia a los schemas en cuerpos de petición o respuesta, o en otros schemas. Al hacer referencia a un modelo de datos compartido, puede mantener la coherencia y optimizar la integración del modelo de datos en varios componentes del diseño de su API.

Propósito de Schema en Apidog#

Crear un Schema#

Construir el Schema#

Aplicar el Schema#

Propósito de Schema en Apidog

Crear un Schema

Construir el Schema

Aplicar el Schema