Quick documentation

Author: tobyzerner

docs/openapi.md

@@ -1,3 +1,13 @@
 # OpenAPI Definitions
 
-Coming soon...
+You can generate an OpenAPI 3.1.0 Definition for your API using the
+`OpenApiGenerator` class.
+
+```php
+use Tobyz\JsonApiServer\JsonApi;
+use Tobyz\JsonApiServer\OpenApi\OpenApiGenerator;
+
+$api = new JsonApi();
+
+$definition = (new OpenApiGenerator())->generate($api);
+```

tests/feature/OpenApiTest.php

@@ -27,6 +27,8 @@ public function test_generates_openapi_spec()
 
         $generator = new OpenApiGenerator();
 
+        $definition = $generator->generate($api);
+
         $this->assertArraySubset(
             [
                 'openapi' => '3.1.0',
@@ -85,7 +87,7 @@ public function test_generates_openapi_spec()
                     'url' => 'https://jsonapi.org/format/1.1/',
                 ],
             ],
-            $generator->generate($api),
+            $definition,
         );
     }
 }