feat(docs): use strapi documentation plugin to generate api your docu…

…mentation(swagger ui); 使用strapi document plugin 自动生成API 文档(由swagger ui 驱动)
ly525 · Dec 16, 2019 · cb6cf47 · cb6cf47
1 parent 4e28516
commit cb6cf47
Show file tree

Hide file tree

Showing 10 changed files with 8,512 additions and 17 deletions.
diff --git a/back-end/h5-api/api/work/documentation/1.0.0/work.json b/back-end/h5-api/api/work/documentation/1.0.0/work.json
diff --git a/back-end/h5-api/api/workform/documentation/1.0.0/workform.json b/back-end/h5-api/api/workform/documentation/1.0.0/workform.json
diff --git a/back-end/h5-api/extensions/documentation/documentation/1.0.0/full_documentation.json b/back-end/h5-api/extensions/documentation/documentation/1.0.0/full_documentation.json
diff --git a/back-end/h5-api/extensions/documentation/public/index.html b/back-end/h5-api/extensions/documentation/public/index.html
diff --git a/back-end/h5-api/extensions/email/documentation/1.0.0/email-Email.json b/back-end/h5-api/extensions/email/documentation/1.0.0/email-Email.json
@@ -0,0 +1,80 @@
+{
+  "paths": {
+    "/email/": {
+      "post": {
+        "deprecated": false,
+        "description": "Send an email",
+        "responses": {
+          "200": {
+            "description": "response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "properties": {
+                    "foo": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "default": {
+            "description": "unexpected error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        },
+        "summary": "",
+        "tags": [
+          "Email - Email"
+        ],
+        "requestBody": {
+          "description": "",
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "properties": {
+                  "foo": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "tags": [
+    {
+      "name": "Email - Email"
+    }
+  ]
+}