docs

Author: hauner

docs/generatr/index.md

@@ -8,7 +8,7 @@ has_children: true
 # The generatr
 
 The openapi-generatr-spring is an **interface only** open api generatr. That means it will only
-generate a java interfaces for the endpoints. It is the projects task to implement them.
+generate java interfaces for the endpoints. It is the projects task to implement them.
 
 Let's take a look at a very simple example. The following open api yaml describes a very simple
 endpoint. A call to the `/ping` endpoint will simply respond with a plain text string result. 

docs/generatr/interfaces.md

@@ -7,5 +7,39 @@ nav_order: 5
 
 # Interfaces
 
-  todo
-  {: .label .label-yellow }
+The generatr groups endpoints based on their _first_ tag. Using the `/ping` example again its first
+(and only) tag is **ping**: 
+
+```yaml
+    openapi: 3.0.2
+    info:
+      title: sample api for openapi-generatr-spring
+      version: 1.0.0
+    
+    paths:
+      /ping:
+        get:
+          tags:
+            - ping
+          summary: returns a single "pong" string.
+          description: very simple sample endpoint
+          responses:
+            '200':
+              description: pong
+              content:
+                text/plain:
+                  schema:
+                    type: string
+```
+
+The interface name used for this api will be `PingApi`. `Ping` because `ping` is the tags name and
+`Api` as a fixed string added to `Ping`. 
+
+In case no tags are given, all endpoints will be added to an `Api` interface.
+
+The package name gets created from the configurable `packageName` parameter of the generatr and a
+sub package named `api`. 
+
+If the `packageName` is configured as `com.github.hauner.openapi` the final package name for the 
+interface is `com.github.hauner.openapi.api` and the full class & package name is 
+`com.github.hauner.openapi.api.PingApi`.