Overview of OpenAPI integration in gluo
The gluo framework uses an openapi.json file as a single source of truth to describe HTTP APIs. This specification drives three primary system functions:
- Runtime Routing:
OpenApiRouteListreads the JSON file to map incoming requests to controller methods. - Swagger UI: An interactive browser interface is served at
http://localhost:8080/docs/for exploring and testing endpoints. - Contract Testing:
OpenApiValidation(viaByJG\\ApiTools) ensures that test responses conform to the declared schema.