add API docs

Author: carlosthe19916

api/src/main/java/io/github/project/openubl/xmlbuilder/resources/DocumentsResource.java

@@ -64,8 +64,8 @@ public class DocumentsResource {
 
     public final static String SIGNATURE_ID = "PROJECT-OPENUBL";
 
-    public final static String X_HEADER_PRIVATEKEY = "X-OPENBUL-PRIVATEKEY";
-    public final static String X_HEADER_CERTIFICATEKEY = "X-OPENUBL-CERTIFICATEKEY";
+    public final static String X_HEADER_PRIVATEKEY = "x-openubl-privatekey";
+    public final static String X_HEADER_CERTIFICATEKEY = "x-openubl-certificatekey";
 
     @Inject
     @CDIProvider

distribution/server-x/src/main/resources/META-INF/openapi.yaml

@@ -1,15 +1,6 @@
 ---
-openapi: 3.0.1
 info:
-  title: XSender Server API
-  contact:
-    name: XSender Server Support
-    url: https://github.com/project-openubl/xbuilder-server/issues
-    email: [email protected]
-  license:
-    name: Eclipse Public License - v 2.0
-    url: https://www.eclipse.org/legal/epl-2.0/
-  version: "1.0.0.Final"
+  title: XBuilder Server API
 tags:
   - name: enrich
     description: Enrichment related operations.

docusaurus/docusaurus.config.js

@@ -1,6 +1,7 @@
 module.exports = {
   title: "XBuilder",
-  tagline: "Microservice for creating and signing XML files based on Universal Bussiness Language (UBL)",
+  tagline:
+    "Microservice for creating and signing XML files based on Universal Bussiness Language (UBL)",
   url: "https://project-openubl.github.io/xbuilder-server-docs/",
   baseUrl: "/xbuilder-server-docs/",
   favicon: "img/favicon.ico",
@@ -21,6 +22,7 @@ module.exports = {
           position: "left",
         },
         // { to: "blog", label: "Blog", position: "left" },
+        { to: "api", label: "API", position: "left" },
         {
           href: "https://github.com/project-openubl/xbuilder-server",
           label: "GitHub",
@@ -69,7 +71,7 @@ module.exports = {
       trackingID: "UA-152706512-2",
     },
     gtag: {
-      trackingID: 'UA-152706512-2',
+      trackingID: "UA-152706512-2",
     },
   },
   stylesheets: [

docusaurus/package.json

@@ -14,7 +14,8 @@
     "@docusaurus/preset-classic": "^2.0.0-alpha.58",
     "clsx": "^1.1.1",
     "react": "^16.8.4",
-    "react-dom": "^16.8.4"
+    "react-dom": "^16.8.4",
+    "swagger-ui-react": "^3.28.0"
   },
   "browserslist": {
     "production": [

docusaurus/src/css/custom.css

@@ -8,18 +8,18 @@
 /* You can override the default Infima variables here. */
 :root {
   --ifm-font-family-base: "Red Hat Text", "Overpass", helvetica, sans-serif;
-  --ifm-color-primary: #EC7A08;
-  --ifm-color-primary-dark: #C46100;
-  --ifm-color-primary-darker: #8F4700;
-  --ifm-color-primary-darkest: #773D00;
-  --ifm-color-primary-light: #EC7A08;
-  --ifm-color-primary-lighter: #EF9234;
-  --ifm-color-primary-lightest: #F4B678;
+  --ifm-color-primary: #ec7a08;
+  --ifm-color-primary-dark: #c46100;
+  --ifm-color-primary-darker: #8f4700;
+  --ifm-color-primary-darkest: #773d00;
+  --ifm-color-primary-light: #ec7a08;
+  --ifm-color-primary-lighter: #ef9234;
+  --ifm-color-primary-lightest: #f4b678;
   --ifm-code-font-size: 95%;
 }
 
 .hero.hero--primary {
-  --ifm-hero-background-color: #EC7A08;
+  --ifm-hero-background-color: #ec7a08;
   /* --ifm-hero-text-color: var(--ifm-font-color-base); */
   background-color: var(--ifm-hero-background-color);
   color: var(--ifm-hero-text-color);
@@ -32,7 +32,7 @@
   color: var(--ifm-hero-text-color);
 }
 
-.hero.hero--primary .button.button--secondary {  
+.hero.hero--primary .button.button--secondary {
   color: #fff !important;
 }
 
@@ -45,4 +45,9 @@
 
 .footer.footer--dark {
   --ifm-footer-background-color: #000;
+}
+
+/* Swagger */
+.swagger-ui pre {
+  background-color: transparent;
 }