the big picture

slashquery · Jun 3, 2017 · fe67119 · fe67119
1 parent 90199e8
commit fe67119
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,27 @@
 # SlashQuery
 
 API Gateway
+
+The big picture:
+
+```pre
+   (slashquery API Gateway)
+
+api.example.com/<path endpoint>
+               |            (plugins)       (upstream)      (microservices)
+               |                                            /home
+               | /*     >--[middleware]---[LoadBalancer]--< /home
+               |                                            /home
+               |
+               |                                            /foo
+               | /foo/* >--[middleware]---[LoadBalancer]--< /foo
+               |                                            /foo
+               |
+               |                                            /foo-version-2
+ (versioning)  | /foo/* >--[middleware]---[LoadBalancer]--< /foo-version-2
+               |                                            /foo-version-2
+               |
+               |                                            /bar
+               ` /bar/* >--[middleware]---[LoadBalancer]--< /bar
+                                                            /bar
+```