One element of API Platfom landscape is API documentation server. This server shares information about available API exposed by Iptor. API Documentation server is built based on Swagger UI server, and is used to expose OpenAPI sepcifications. It plays two roles in API platform infrastructure:
The first point is quite obvious, but second need some explanation. To expose API in Iptor infrastructure we use API Bridge software. API Bridge software exposes “core API endpoints” which are hardcoded in this program. It also exposes dynamic API endpoints. These dynamic API endpoints are based on OpenAPI specification injected during start of API Bridge container. To inject OpenAPI specification we use shared document from API documentation server. We use also API documentation server to serve OpenAPI spec as source for API Gateway configuration.
NOTE: API documentation server plays central role as single point of truth for all API Bridges and API Gateway.
Both, above servers are used to inject OpenAPI specification into all PD internal API bridges.