Cliente OpenAPI de Adder para Go
Cliente OpenAPI de Adder para Go
Sección titulada «Cliente OpenAPI de Adder para Go»Instalación
Sección titulada «Instalación»Instala las siguientes dependencias:
go get github.com/stretchr/testify/assertgo get golang.org/x/net/contextMigración de la ruta del módulo
Sección titulada «Migración de la ruta del módulo»El cliente OpenAPI generado ahora pertenece al módulo github.com/blinklabs-io/adder/openapi. Sustituye cualquier referencia al módulo anterior:
Antes:
import openapi "github.com/blinklabs-io/cardano-node-api/openapi"Después:
import openapi "github.com/blinklabs-io/adder/openapi"En go.mod, actualiza la declaración del módulo a la siguiente:
module github.com/blinklabs-io/adder/openapiReferencia de la API
Sección titulada «Referencia de la API»La API organiza las rutas de supervisión y eventos en la raíz, y las funciones de notificaciones y código QR bajo /v1.
Rutas raíz
Sección titulada «Rutas raíz»| Método | Ruta | Comportamiento |
|---|---|---|
GET | /ping | Devuelve pong para confirmar que el servidor responde. También acepta /ping/. |
GET | /healthcheck | Devuelve el estado de salud en JSON. Responde con 200 cuando todos los componentes funcionan y con 503 cuando alguno falla. También acepta /healthcheck/. |
GET | /events | Entrega eventos mediante SSE cuando la solicitud no pide una actualización WebSocket. Cuando la solicitud incluye cabeceras de actualización WebSocket, intenta establecer una conexión WebSocket y devuelve un error WebSocket si no puede completarla, sin cambiar a SSE. El servidor no aplica un límite de escritura para conservar las conexiones de streaming de larga duración. |
El cliente debe interpretar el error WebSocket como el resultado final de la solicitud. El servidor no entrega una respuesta SSE alternativa.
El servidor genera registros de acceso estructurados y recupera los errores inesperados de los controladores sin interrumpir el proceso.
Rutas /v1
Sección titulada «Rutas /v1»| Método | Ruta | Comportamiento |
|---|---|---|
POST | /v1/fcm | Recibe un objeto JSON con un campo fcmToken no vacío y devuelve 201 cuando guarda el token. También acepta /v1/fcm/. El servidor devuelve una respuesta JSON con estado 400 cuando recibe JSON mal formado o cuando falta fcmToken. |
GET | /v1/fcm/{token} | Devuelve el token en JSON con estado 200, o 404 si no existe. También acepta una barra final. |
DELETE | /v1/fcm/{token} | Elimina el token y devuelve 204, o devuelve 404 si no existe. También acepta una barra final. |
GET | /v1/qrcode | Devuelve la página HTML que genera el código QR de conexión. También acepta /v1/qrcode/. |
Swagger
Sección titulada «Swagger»La interfaz Swagger está disponible en GET /swagger/. La URL práctica incluye la barra final, por ejemplo https://servidor.example/swagger/.
Docs authored by Doc Holiday