Swaggerdefinitie FM DataAPI en AdminAPI

[menno]

Voor een leverancier van een klant had ik een swagger-definitie van de data-api nodig. Ik kon die nergens vinden en heb er eentje gemaakt voor de beperkte set met eindpunten die zij gingen gebruiken. Dat kostte best wat moeite en intussen had ik in de Claris Community gevraagd of iemand toevallig al zoiets heeft liggen.

Het blijkt dat in de map FileMaker/FileMaker Server/Web Publishing/publishing-engine/node-wip/dapi_v1.json wel een redelijk goede definitie staat. Deze heb ik een beetje aangepast naar de OpenAPI_v3 en die kan je gemakkelijk in PostMan etc. importeren (zie de bijlage OpenApi.zip)

de editor in het screenshot kan je gebruiken via: https://editor.swagger.io/ en als je die lokaal wilt draaien, kan je die downloaden van: https://github.com/swagger-api/swagger-editor

De specificatie uit de bijlage (hij is beschikbaar in 2 verschillende formaten json en yaml) kan je in deze editor en ook in PostMan importeren, dat kan enorm helpen als je met de DataAPI wilt koppelen.

OpenApi.zip

[menno]

Voor AdminAPI heb eenzelfde definitie gevonden en bewerkt.  Deze is heel wat uitgebreider:

OpenAPI_AdminAPI.zip

[menno]

Met versie 20(23) zijn er ook wat aanpassingen in deze beide API's. Hier vind je de aangepaste OpenAPI-definties:

DataApi_AdminApi_FM20_JSON.zip

[menno]

Met versie 20(24) zijn er weer wat aanpassingen in deze beide API's t.o.v. 2023. Hier vind je de aangepaste OpenAPI-definties:

DataApi_AdminApi_FM21_JSON.zip

Tegenwoordig zitten er in de documentatie van fmserver knopjes waarmee de definities kan downloaden:
https://<serverip>/fmi/admin/apidoc/
https://<serverip>/fmi/data/apidoc/