ditkrg/rswag
5
0
Fork 0
mirror of https://github.com/ditkrg/rswag.git synced 2026-01-25 07:16:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

rename to rswag plus major refactor - almost a rewrite

Browse Source
This commit is contained in:
richie
2016-10-11 18:31:12 -07:00
parent f8d993356f
commit c558098c39
453 changed files with 52410 additions and 35793 deletions
Download Patch File Download Diff File Expand all files Collapse all files

153
test-app/swagger/v1/swagger.json Normal file
View File

@@ -0,0 +1,153 @@
{
"swagger": "2.0",
"info": {
"title": "API V1",
"version": "v1"
},
"paths": {
"/blogs": {
"post": {
"summary": "Creates a blog",
"tags": [
"Blogs"
],
"description": "Creates a new blog from provided data",
"operationId": "createBlog",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "blog",
"in": "body",
"schema": {
"$ref": "#/definitions/blog"
}
}
],
"responses": {
"201": {
"description": "blog created"
},
"422": {
"description": "invalid request",
"schema": {
"$ref": "#/definitions/errors_object"
}
}
}
},
"get": {
"summary": "Searches blogs",
"tags": [
"Blogs"
],
"description": "Searches blogs by keywords",
"operationId": "searchBlogs",
"produces": [
"application/json"
],
"parameters": [
{
"name": "keywords",
"in": "query",
"type": "string"
}
],
"responses": {
"200": {
"description": "success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/blog"
}
}
}
}
}
},
"/blogs/{id}": {
"get": {
"summary": "Retrieves a blog",
"tags": [
"Blogs"
],
"description": "Retrieves a specific blog by id",
"operationId": "getBlog",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"type": "string",
"required": true
}
],
"responses": {
"200": {
"description": "blog found",
"schema": {
"$ref": "#/definitions/blog"
}
},
"404": {
"description": "blog not found"
}
}
}
}
},
"definitions": {
"errors_object": {
"type": "object",
"properties": {
"errors": {
"$ref": "#/definitions/errors_map"
}
}
},
"errors_map": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"blog": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"content": {
"type": "string"
}
},
"required": [
"id",
"title",
"content"
]
}
},
"securityDefinitions": {
"api_key": {
"type": "apiKey",
"name": "api_key",
"in": "query"
}
},
"security": {
"api_key": [
]
}
}