From c42a11ff6cd68e29642368efd5a5553391105498 Mon Sep 17 00:00:00 2001 From: Afzal Ansari Date: Tue, 1 Aug 2023 14:13:04 +0000 Subject: [PATCH] adds glee feature points and its diagram way Signed-off-by: Afzal Ansari --- docs/pages/intro.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/docs/pages/intro.md b/docs/pages/intro.md index 281444c0e..e6647bcf3 100644 --- a/docs/pages/intro.md +++ b/docs/pages/intro.md @@ -3,7 +3,29 @@ title: 'Introduction' weight: 20 --- -[Glee](https://github.com/asyncapi/glee) is a spec-first framework that helps you build server-side applications. It leverages the AsyncAPI specification to make you more productive: +[Glee](https://github.com/asyncapi/glee) is a spec-first framework that helps you build server-side applications. That means it operates on the principle of defining the API specification (AsyncAPI) before diving into the actual implementation of the application logic. It leverages that principle to make you more productive: -- Glee ensures your code and AsyncAPI definition are on par, eliminating the problem of outdated documentation. Glee takes care of this automatically for you. -- Glee lets you focus on what matters and handles the rest for you. You only write the code for your business use-case. Glee takes care of performance, scalability, resilience, and everything you need to make your application production-ready. \ No newline at end of file +- Glee ensures your code and AsyncAPI definition are on par, eliminating the problem of outdated documentation. By having both the code and the AsyncAPI definition in sync, you can ensure that the API documentation is always up to date, accurate, and reflects the current state of the application. Glee takes care of this automatically for you. +- Glee lets you focus on what matters and handles the rest for you. You only write the code for your business use-case. Glee takes care of performance, scalability, resilience, and everything you need to make your application production-ready. +- Glee validates the schema of the payload that it receives, if it doesn't conform to the schema that is defined in the AsyncAPI document, it throw an error telling user that the server received an invalid payload. + +To summarize, the Glee offers the following features and process flow, as shown in the diagram below: + +```mermaid +graph TD; +A[AsyncAPI Glee CLI] +B[Creation] +H[Generation] +I[Optimization] +D[Validation] +F[Apps/Docs] +K[Bundling] +E[Conversion] +A-->B; +A-->D; +A-->H +H-->F +A-->I; +A-->E; +A-->K; +```