HTTP API v1 ülevaade
Kasuta Autonomy 23 toimingut skriptidest, CI-töödest ja muudest HTTP-klientidest.
HTTP API v1 laseb skriptidel, CI-töödel ja teenustel Autonomyga otse töötada. See hõlmab projekte, testjuhtumeid, testiplaane, käivitusi (koos nende Step Actions'i ja tõenditega), keskkondi ja probleeme.
Baas-URL on https://api.autonomyqa.com. Kõik toimingud kasutavad sama marsruudikuju ja JSON-objektist keha:
POST https://api.autonomyqa.com/api/v1/<resource>.<verb>
Authorization: Bearer <credential>
Content-Type: application/jsonNäiteks test_case.create on POST /api/v1/test_case.create ja run.get on POST /api/v1/run.get. Päringustringi pole: kõik argumendid lähevad kehasse, ka lugemistoimingute puhul. Eduka vastusena tagastatakse toimingu tulemus JSON-ina, ilma ümbriseta.
Masinloetav OpenAPI 3.1 dokument asub aadressil GET /api/openapi.json. Iga toimingu operationId on selle nimi, milles punkt on asendatud alakriipsuga, näiteks test_case_create, ja x-scope nimetab õiguse, mida toiming vajab.
Toimingud lühidalt
| Ressurss | Toimingud |
|---|---|
| Projektid | project.list, project.get |
| Testjuhtumid | test_case.list, test_case.get, test_case.create, test_case.update_steps, test_case.archive |
| Testiplaanid | test_plan.list, test_plan.get, test_plan.create, test_plan.set_members |
| Käivitused | run.trigger, run.list, run.get, run.step_actions, run.evidence |
| Keskkonnad | environment.list, environment.get, environment.upsert |
| Probleemid | issue.list, issue.create, issue.comment, issue.set_status |
Testjuhtumi, testiplaani või keskkonna loomiseks on vaja projectId-d ja loenditoiminguid saab selle järgi filtreerida. Selle leidmiseks kutsu esmalt project.list.
HTTP API ja MCP
HTTP-l ja MCP-l on samad 23 toimingut samade argumentide, tulemuste, õiguste, kinnitusreeglite ja vigadega. MCP-s on iga toiming tööriist, mille nimi on autonomy_ pluss toimingu nimi, milles punktid on asendatud alakriipsudega, näiteks autonomy_run_get.
Kasuta MCP-d, kui AI-assistent peaks redaktoris Autonomyga töötama. Kasuta seda HTTP API-t skriptide, CI-torude ja JSON-päringuid saatvate süsteemide jaoks. Need erinevad sisselogimise poolest: HTTP API aktsepteerib organisatsiooni API-võtmeid ja OAuthi tokeneid, MCP aga ainult OAuthi.
Alustamine
- Autendi iga päring.
- Vali toiming toimingukataloogist.
- Jälgi käivitusi ja loe nende tõendeid käivituste ja tõendite töövoo järgi.
- Käsitle vigu.
Ei leidnud?