diff --git a/dmnverifierapi/README.md b/dmnverifierapi/README.md index 4b9b4621be054c0fa8d092a78e8e9761577c3e27..0f91a6df3da1a11b74979d7829a48bb4bc7766e8 100644 --- a/dmnverifierapi/README.md +++ b/dmnverifierapi/README.md @@ -7,6 +7,8 @@ This project contains all source files of the implementation, created for the ma - [Frontend Project](../dmnverifierfrontend) ## Backend +[Api Documentation](docApi.md) + Based on - [Quarkus](https://quarkus.io/) - [Camunda DMN](https://github.com/camunda/camunda-dmn-model/) diff --git a/dmnverifierapi/docApi.md b/dmnverifierapi/docApi.md new file mode 100644 index 0000000000000000000000000000000000000000..9abf871863b8780ecf4222af3e27a27b3ffc2863 --- /dev/null +++ b/dmnverifierapi/docApi.md @@ -0,0 +1,56 @@ +# Documentation API + +Root path: <code>/api</code> + +<h3>Verifications</h3> +<h4>Get all verifications from all verifiers with the given dmn table</h4> +<ul> + <li>POST</li> + <li><code>/api/dmn/verification/</code></li> + <li>Consumes: text/xml - the dmn table as xml string</li> + <li>Produces: application/json</li> +</ul> + +<h3>Verification classifications</h3> +<h4>Get a list of all verification classifications</h4> +<ul> + <li>GET</li> + <li><code><a href="/api/dmn/verification/classification" target="_blank">/api/dmn/verification/classification</a></code> + </li> + <li>Produces: application/json</li> +</ul> +<h4>Get all verifications for the given verification classification</h4> +<ul> + <li>POST</li> + <li><code>/api/dmn/verification/classification/{classificationName}</code></li> + <li>Consumes: text/xml - the dmn table as xml string</li> + <li>Produces: application/json</li> +</ul> + +<h3>Verification types</h3> +<h4>Get a list of all verification types</h4> +<ul> + <li>GET</li> + <li> + <code><a href="/api/dmn/verification/type" + target="_blank">/api/dmn/verification/type</a></code> + </li> + <li>Produces: application/json</li> +</ul> +<h4>Get all verifications for the given verification type</h4> +<ul> + <li>POST</li> + <li><code>/api/dmn/verification/classification/{classificationName}</code></li> + <li>Consumes: text/xml - the dmn table as xml string</li> + <li>Produces: application/json</li> +</ul> +<h3>Metrics</h3> +<h4>Get some statistics about execution times</h4> +<ul> + <li>GET</li> + <li> + <code><a href="/api/dmn/verification/metrics" + target="_blank">/api/dmn/verification/metrics</a></code> + </li> + <li>Produces: application/json</li> +</ul>