Detailed Information

This example project demonstrates how to document the REST APIs of a microservice with the jEAP Swagger starter, which builds on springdoc-openapi and serves the generated OpenAPI documents in an interactive Swagger UI. It shows how to declare an OpenAPI definition, how to split the endpoints of a service into several API groups and API versions, how to describe endpoints and payloads with OpenAPI annotations, and how to try the documented endpoints out in the Swagger UI authenticated with OAuth 2.0. It also demonstrates the access modes the starter provides for the Swagger UI. The example consists of a microservice documenting its REST APIs (jme-swagger-service), an instance of the jEAP OAuth mock server providing the login for the Swagger UI (jme-swagger-auth-scs) and a module with reusable smoke checks for the Swagger endpoints and the integration tests of this example (jme-swagger-test).