Generate API

Sequence

sequenceDiagram participant Cms participant Build Client participant Build Agent participant Artifact Repository Cms->>Build Client: Generate API (Run pipeline) Note left of Cms: Continuous loop loop Check Status Cms->>Build Client: Status? Build Client->>Cms: Busy/Succeeded/Failed end Build Client->>Build Agent: Run script (yml) Build Agent->>Build Agent: Runs code Build Agent ->> Cms: Request Data Cms ->> Build Agent: Provides Data Build Agent->>Build Agent: Generates artifact Build Agent->>Artifact Repository: Push artifact Build Agent->>Build Client: Pipeline completed

Build pipeline

Generator Variables

Naam	Omschrijving	Waarde type	Voorbeeld
OpenApi_Authentication	Het type authenticatie	Anonymous Bearer	Anonymous
OpenApi_CmsUrl	De URL naar de CMS omgeving	string	https://app-naam-omgeving-cms.azurewebsites.net/
OpenApi_DocumentationDescription	Een omschrijving van de omgeving	string	REST API voor [naam omgeving]
OpenApi_DocumentationTitle	De titel voor de API documentatie	string	[naam omgeving] API
OpenApi_DocumentationVersion	De versie van de omgeving	string	1.0.0
OpenApi_EnvSyn	De ID van de omgeving voor synchronisatie met IPROX	string	api
OpenApi_IsDevelopment	Genereren voor development	boolean	false
OpenApi_Preview	Preview Endpoints	boolean	false