OpenAPI / Swagger

La spec OpenAPI 3.0 de la API de MultiMensajes esta disponible. Sirve para generar SDKs en cualquier lenguaje, validar requests, o explorar la API visualmente con Swagger UI o Stoplight.

Descargar la spec

Descargar openapi.json

Es un archivo JSON con todos los endpoints, parametros, schemas, autenticacion y ejemplos.

Visualizar en Swagger UI

Para explorar la API visualmente, abre el spec en uno de estos servicios:

Como generar un SDK automaticamente

Con la spec OpenAPI puedes generar un cliente listo para usar en tu lenguaje favorito:

JavaScript / TypeScript

npm install -g openapi-typescript-codegen
openapi-typescript-codegen --input openapi.json --output ./cliente-js

Python

pip install openapi-python-client
openapi-python-client generate --path openapi.json --output-path ./cliente-python

PHP

composer require openapi-tools/openapi-generator
npx @openapitools/openapi-generator-cli generate \
  -i openapi.json \
  -g php \
  -o ./cliente-php

Go

go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@latest
oapi-codegen -package cliente openapi.json > cliente.go

Como validar requests en tests

Si quieres asegurarte de que tus requests cumplen el contrato, usa la spec en tus tests:

// Python: schemathesis
import schemathesis
schema = schemathesis.from_path("openapi.json")

@schema.parametrize()
def test_api(case):
    case.call_and_validate()

Usar la spec en Postman / Insomnia

Tambien puedes importar la spec directamente en Postman o Insomnia para auto-generar las requests:

Si tienes dudas, revisa tambien la guia de Postman.