Merge branch 'master' of https://github.com/cdimascio/express-middlew…

…are-openapi

README.md

@@ -4,6 +4,8 @@
 
 ExpressJs middleware that automatically validates API requests using an OpenAPI 3.0 specification,
 
+Try out the [sample project](https://github.com/cdimascio/express-middleware-openapi-example)
+
 ## Install
 
 Try this pre-release alpha version:
@@ -14,8 +16,6 @@ npm i express-middleware-openapi
 
 ## Usage
 
-see [app.js](example/app.js) for a complete example.
-
 ### Basic
 
 ```javascript
@@ -51,7 +51,7 @@ new OpenApiMiddleware({
 }).install(app);
 ```
 
-## Example
+## Example API Server
 
 Try the complete example below:
 
@@ -100,3 +100,86 @@ console.log('Listening on port 3000');
 
 module.exports = app;
 ```
+
+## [Example API Server (Full Project Source)](https://github.com/cdimascio/express-middleware-openapi-example) 
+
+A full working example lives [here](https://github.com/cdimascio/express-middleware-openapi-example)
+
+## Example validation responses
+
+#### Validate a query parameter with a value constraint
+
+```shell
+curl http://localhost:3000/v1/pets/as |jq
+{
+  "errors": [
+    {
+      "path": "id",
+      "errorCode": "type.openapi.validation",
+      "message": "should be integer",
+      "location": "path"
+    }
+  ]
+}
+```
+
+#### Validate a query parameter with a range constraint
+
+```shell
+curl http://localhost:3000/v1/pets?limit=1 |jq
+{
+  "errors": [
+    {
+      "path": "limit",
+      "errorCode": "minimum.openapi.validation",
+      "message": "should be >= 5",
+      "location": "query"
+    },
+    {
+      "path": "test",
+      "errorCode": "required.openapi.validation",
+      "message": "should have required property 'test'",
+      "location": "query"
+    }
+  ]
+}
+```
+
+#### Validate the query parameter's value type
+
+```shell
+curl --request POST \
+  --url http://localhost:3000/v1/pets \
+  --header 'content-type: application/xml' \
+  --data '{
+        "name": "test"
+}' |jq
+{
+  "errors": [
+    {
+      "message": "Unsupported Content-Type application/xml"
+    }
+  ]
+}
+```
+
+#### Validate a POST body to ensure required parameters are present
+
+```shell
+λ  my-test curl --request POST \
+  --url http://localhost:3000/v1/pets \
+  --header 'content-type: application/json' \
+  --data '{
+}'|jq
+  "errors": [
+    {
+      "path": "name",
+      "errorCode": "required.openapi.validation",
+      "message": "should have required property 'name'",
+      "location": "body"
+    }
+  ]
+}
+```
+
+#### ...and much more. Try it out!