HTTP API v1

HTTP API v1 avab Autonomy QA juhtimistasandi skriptidele, CI-töödele ja teenustele. See hõlmab testjuhtumeid, testiplaane, käivitusi, keskkondi, väliseid tõendeid ja märkmeid.

Määra baas-URL-iks oma Convexi saidi URL ehk NEXT_PUBLIC_CONVEX_SITE_URL väärtus, näiteks https://your-deployment.convex.site. Ära kasuta .convex.cloud URL-i.

Kõik kataloogi toimingud kasutavad sama marsruudikuju ja JSON-objektist keha:

POST <NEXT_PUBLIC_CONVEX_SITE_URL>/api/v1/<resource>.<verb>
Content-Type: application/json

Näiteks test_case.create on POST /api/v1/test_case.create ja run.get on POST /api/v1/run.get. Vastused on JSON-vormingus.

Iga juurutus serveerib masinloetavat OpenAPI 3.1 dokumenti aadressil GET /api/openapi.json. Eraldi juurutuses kasuta selle asemel GET <NEXT_PUBLIC_CONVEX_SITE_URL>/api/openapi.json.

HTTP API ja MCP

HTTP ja MCP luuakse samast toimingukataloogist ning kasutavad seetõttu samu argumente, tagastusväärtusi, õigusi, kinnitamisreegleid ja vigu. MCP avaldab 15 toimingut. Kolm märkmetoimingut on ainult HTTP kaudu, seega sisaldab HTTP API kõiki 18 toimingut.

Kasuta MCP-d, kui AI-assistent peab Autonomyt tööriistaprotokolli kaudu juhtima. Kasuta seda HTTP API-t skriptide, CI-torude ja otse JSON-päringuid vajavate süsteemide jaoks.

Alustamine

1. Autendi iga päring.
2. Vali marsruut toimingukataloogist.
3. Asünkroonsete käivituste puhul järgi käivituste ja väliste tõendite töövoogu.
4. Käsitle suletud hulka struktureeritud vigu.