Initial commit

swagger/swagger.json

@@ -0,0 +1,156 @@
+{
+    "swagger": "2.0",
+    "info": {
+        "title": "beego Test API",
+        "description": "beego has a very cool tools to autogenerate documents for your API\n",
+        "version": "1.0.0",
+        "termsOfService": "http://beego.me/",
+        "contact": {
+            "email": "astaxie@gmail.com"
+        },
+        "license": {
+            "name": "Apache 2.0",
+            "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
+        }
+    },
+    "basePath": "/oc",
+    "paths": {
+        "/version/": {
+            "get": {
+                "tags": [
+                    "version"
+                ],
+                "description": "get version\n\u003cbr\u003e",
+                "operationId": "VersionController.GetAll",
+                "responses": {
+                    "200": {
+                        "description": ""
+                    }
+                }
+            }
+        },
+        "/auth/": {
+            "post": {
+                "tags": [
+                    "auth"
+                ],
+                "description": "create auths\n\u003cbr\u003e",
+                "operationId": "AuthController.Create",
+                "parameters": [
+                    {
+                        "in": "body",
+                        "name": "body",
+                        "description": "The auth content",
+                        "required": true,
+                        "schema": {
+                            "type": "array",
+                            "items": {
+                                "$ref": "#/definitions/models.auth"
+                            }
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "{string} models.auth.Id"
+                    },
+                    "403": {
+                        "description": "body is empty"
+                    }
+                }
+            }
+        },
+        "/auth/find/{query}": {
+            "get": {
+                "tags": [
+                    "auth"
+                ],
+                "description": "find auths with query\n\u003cbr\u003e",
+                "operationId": "AuthController.Find",
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "query",
+                        "description": "the keywords you need",
+                        "required": true,
+                        "type": "string"
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "{auths} []models.auth"
+                    },
+                    "403": {
+                        "description": ""
+                    }
+                }
+            }
+        },
+        "/auth/{authId}": {
+            "get": {
+                "tags": [
+                    "auth"
+                ],
+                "description": "find auth by authid\n\u003cbr\u003e",
+                "operationId": "AuthController.Get",
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "authId",
+                        "description": "the authid you want to get",
+                        "required": true,
+                        "type": "string"
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "{auth} models.auth"
+                    },
+                    "403": {
+                        "description": ":authId is empty"
+                    }
+                }
+            },
+            "delete": {
+                "tags": [
+                    "auth"
+                ],
+                "description": "delete the auth\n\u003cbr\u003e",
+                "operationId": "AuthController.Delete",
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "authId",
+                        "description": "The authId you want to delete",
+                        "required": true,
+                        "type": "string"
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "{string} delete success!"
+                    },
+                    "403": {
+                        "description": "authId is empty"
+                    }
+                }
+            }
+        }
+    },
+    "definitions": {
+        "models.auth": {
+            "title": "auth",
+            "type": "object"
+        }
+    },
+    "tags": [
+        {
+            "name": "auth",
+            "description": "Operations about auth\n"
+        },
+        {
+            "name": "version",
+            "description": "VersionController operations for Version\n"
+        }
+    ]
+}