Kokią užduotį sprendžia
Sukurti partneriams skirtos API sutartį ir kontroliuoti jos keitimą.
Kada rinktis šį agentą
- Keli partneriai integruojasi į tą pačią API ir pakeitimai gali juos paveikti.
Kada reikia kito sprendimo
- Vien vidinei duomenų lentelei taisyti API platformos proceso gali nereikėti.
Kokius duomenis pateikti
- API specifikacija ir klientai — Dabartiniai laukai, pavyzdžiai, SDK ir naudojamos operacijos.
- Keitimo politika — Palaikomos versijos, kvotos, migravimo terminai ir prieigų modelis.
Kokį rezultatą gauti
- OpenAPI arba protobuf sutartis — Validuojama schema su sėkmės ir klaidų atsakais.
- Suderinamumo paketas — Schemų skirtumai, SDK patikra, pakeitimų bei atsisakymo gairės.
Kaip vyksta darbas
- Išteklių modelis — Suderina vardus, ID, būsenas ir privalomumą. Priėmimas: Visi pavyzdžiai atitinka schemą.
- Apsauga nuo pakartojimų — Aprašo idempotentiškumo raktus, kvotas ir 429 elgesį. Priėmimas: Testai apima pakartojimą ir ribos viršijimą.
- Keitimo kontrolė — Lygina seną bei naują sutartį ir tikrina vartotojo kodą. Priėmimas: Nesuderinami pakeitimai turi migravimo kelią.
Įrankiai ir prieigos
- OpenAPI validatorius ir SDK generatorius — Sutarčiai bei klientų kodui tikrinti. Prieiga: Reikia tikros projekto specifikacijos ir pasirinkto generatoriaus.
Ribos ir žmogaus sprendimai
- Sugeneruotas SDK savaime neįrodo, kad serveris laikosi specifikacijos.
Žmogaus sprendimai
- Nustato partnerių migravimo terminą ir seno API išjungimą.
Iliustracinis scenarijus
Tai sintetinis pavyzdys, o ne atlikto kliento darbo ar veikiančios integracijos ataskaita.
Prielaidos.
- Sintetinė užsakymų API turi veikiančių v1 klientų.
Įvestis. Siūloma quantity lauką pervadinti į count; klientas po nutrūkusio ryšio kartoja POST su raktu order-17.
Veiksmai.
- Pervadinimą pažymi kaip galimą kliento sutrikdymą ir išlaiko v1 lauką.
- Aprašo vieno rakto susiejimą su vienu užsakymu bei konfliktą pakeitus turinį.
Laukiamas rezultatas. Suderinamumo išvada, naujos versijos pasiūlymas ir testas: du vienodi POST su order-17 grąžina tą patį užsakymo ID.
Kada sustoti. Nežinoma, kiek klientų naudoja seną lauką, todėl jo išjungimo data netvirtinama.
Kaip patikrinti rezultatą
- Sutarties pilnumas — Validatorius išsprendžia visas schemų nuorodas.
- Klientų suderinamumas — Senos bibliotekos bandymas ir schemų palyginimo rezultatas.
Susiję vaidmenys ir sprendimai
- Sistemų architektas — Kai API sprendimą reikia susieti su paslaugų ir duomenų architektūra.
- Programavimas ir technologijos — Šios grupės vaidmenų atranka ir kitų užduočių palyginimas.
Profilio kilmė
Aprašas pritaikytas pagal „agency-agents“ vaidmenį „API Platform Engineer“. Prisegtas originalus šaltinis. MIT licencija. Copyright (c) 2025 AgentLand Contributors.
MB Pinet · Verslomatika. Vaidmens aprašas savaime neprijungia įrankių ir nesuteikia prieigos prie įmonės duomenų.
Profilio pagrindas: agency-agents / engineering/engineering-api-platform-engineer.md. Viešas aprašas pritaikytas Verslomatikos procesams.
Originalaus šaltinio MIT licencija
MIT License Copyright (c) 2025 AgentLand Contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.