Integracne manualy - porovnanie so zahranicim

1

Pre zaujimavost takto vyzera “integracny manual” pre platobnu platformu v UK. https://gds-payments.gelato.io/reference/docs/this-documentation

Zaujimave su tam tieto momenty:

  • je to verejne (u nas pokial viem cloveka privita velky oznam - bacha autorske prava!)
  • zverejnuju to uz v bete (nie po schvaleni).
  • pouzivaju normalne komercne riesenie (https://gelato.io/), kde je api explorer, ukazky atd atd. (a nie nejaky privatny kupeny sharepoint, ktovie za kolko s wordovskymi dokumentami)
  • REST (nabozensku vojnu si odpustime a povedme, ze historicky je u nas interne pouzivany SOAP)

Z horror stories, ktore som pocul o integracnych zameroch, neochote spolupracovat a tom ako funguju integracie u nas mi to pride ako z uplne ineho sveta. V komercii samozrejme je to uz dnes takmer nepisany standard.

Dalsie citanie https://governmentasaplatform.blog.gov.uk/2016/01/14/improving-developer-documentation/

Ake su vase skusenosti s integracnymi manualmi a integraciami na IS VS?

3 Likes
2

Aby sme zahranicne integracne manualy len nechvalili, musim spomenut priklad integracneho manualu na system SFC2014, kde ti miesto manualu daju len Javadoc, ktory obsahuje nielen public ale aj private API. Resp. sa o API ani neda hovorit, je to proste javadoc vygenerovany nad celym projektom. K tomu ti pribalia 1 A4 textu s hintami, kde zhruba mas hladat integracne servisy. Ak by si cakal aj nejaky domenovy pohlad a vysvetlenie, tak smola, najdes tam len strohy popis jednotlivych atributov a rozhrani.