Documentación de la API REST - Swagger/OpenAPI
Sterling™ Order Management El sistema ofrece una documentación completa de la API REST mediante el estándar OpenAPI 3.0, anteriormente conocido como Swagger. Este sistema de documentación ofrece una referencia completa de la API, pruebas interactivas, esquemas estructurados, funciones de búsqueda y una interfaz fácil de usar.
Visión general
El sistema de documentación de Swagger/OpenAPI ofrece las siguientes funciones:
- Referencia completa de la API : información detallada sobre todos los puntos finales de la API REST disponibles en el sistema « Sterling Order Management ».
- Esquemas estructurados : definiciones claras de las estructuras de datos de las solicitudes y las respuestas.
- Funciones de búsqueda : Encuentra rápidamente las API en todos los módulos.
- Interfaz intuitiva : documentación en HTML fácil de consultar.
Ventajas
La documentación de « Swagger/OpenAPI » ofrece las siguientes ventajas principales:
- Integración más rápida : los desarrolladores pueden familiarizarse rápidamente con las API del sistem Sterling Order Management e integrarlas.
- Autoservicio : explora y prueba las API sin necesidad de ponerte en contacto con el servicio de asistencia.
- Información precisa : generada automáticamente a partir del código fuente, lo que garantiza su exactitud.
- Basado en estándares : compatible con herramientas API populares como Postman e Insomnia.
- Siempre actualizado : se actualiza con cada lanzamiento del sistema « Sterling Order Management ».
cómo empezar
Para empezar a utilizar la documentación de Swagger/OpenAPI, sigue estos pasos:
- Genera la documentación utilizando los comandos proporcionados.
- Descubre las funciones principales que se describen en la documentación.
- Comprender la estructura y la organización de la documentación.
- Accede a la documentación HTML interactiva o a las especificaciones JSON.