2023-03-03

Phase 2 Todo Quarkus Kafka: reflexion sur les endpoints et création du document openAPI #dev

• utilisation de https://github.com/Mermade/openapi-gui
  • OpenAPI-GUI is a GUI for creating and editing OpenAPI version 3.0.x JSON/YAML definitions. In its current form it is most useful as a tool for starting off and ¬editing simple OpenAPI definitions. Imported OpenAPI 2.0 definitions are automatically converted to v3.0.
    • Clone the repository.
    • Run docker build -t mermade/openapi-gui . to build the Docker image (mermade/openapi-gui)
    • Run docker run --name openapi-gui -p 8081:3000 -d mermade/openapi-gui to run the server on port 8081.
    • Navigate to http://localhost:8081
• utilisation de quarkus-smallrye-openapi pour utiliser l'annotation @OpenAPIDefinition et @Operation pour ajouter des metadata sur les endpoints et générer automatiquement un openAPI swagger.