sanic-org / sanic-openapi Goto Github PK

blueprint = Blueprint('Authentication')
@blueprint.get("/")
@doc.summary('Get a list of all users')
@doc.produces(Status)
async def get_users(request, user):
    return json({'success': True})

blueprint = Blueprint('Authentication', '/auth')
@blueprint.get("/")
@doc.summary('Get a list of all users')
@doc.produces(Status)
async def get_users(request, user):
    return json({'success': True})

Response:
  required:
    - application
    - version
    - api_version
    - contact
    - status
  properties:
    application:
      type: string
    version:
      type: string
    api_version:
      type: string
    contact:
      type: string
    status:
      type: integer

BuildingsResponse:
  type: object
  allOf:
      - $ref: "#/definitions/Response"
      - type: object
        properties:
          data:
            type: array
            items:
              $ref: "#/definitions/Building"
          metadata:
            type: object
            properties:
              building_id:
                type: integer

@blueprint.post("/comment", strict_slashes=True)
@doc.summary("GitHub comment parser")
@doc.description("Handle GitHub comment events")
@doc.consumes({'X-Hub-Signature': str}, location='header', required=True)
@authorized(os.environ.get('GITHUB_S2S_SECRET', None))
async def githubCommentHandler(request):
        return json({'msg': 'processed'})

@app.route("/new_moment/<uid:int>",methods=["POST"])
@doc.consumes({
    "type":int,
    "res_json":str,
    "words":str,
    "location":str
})
def test():

from sanic import Sanic
from sanic_openapi import swagger_blueprint, openapi_blueprint

def create_app():
    app = Sanic(__name__)

    app.blueprint(openapi_blueprint)
    app.blueprint(swagger_blueprint)

    from .api import v1
    app.blueprint(v1)

    return app

class RouteSpec(object):
    consumes = None
    consumes_content_type = None
    produces = None
    produces_content_type = None
    summary = None
    description = None
    operation = None
    blueprint = None
    tags = None
    exclude = None
    response = None
--------
            endpoint = remove_nulls({
                'operationId': route_spec.operation or route.name,
                'summary': route_spec.summary,
                'description': route_spec.description,
                'consumes': consumes_content_types,
                'produces': produces_content_types,
                'tags': route_spec.tags or None,
                'parameters': route_parameters,
                'responses': responses
            })

{
	"swagger": "2.0",
	"info": {
		"version": "1.0.0",
		"title": "FUND SLB SVC API",
		"description": "FUND SLB SVC API",
		"termsOfService": "",
		"contact": {
			"email": null
		},
		"license": {
			"name": null,
			"url": null
		}
	},
	"schemes": ["http"],
	"securityDefinitions": {
		"authToken": {
			"type": "apiKey",
			"in": "header",
			"name": "Authorization",
			"description": "Paste your auth token and do not forget to add \"Bearer \" in front of it"
		},
		"OAuth2": {
			"type": "oauth2",
			"flow": "application",
			"tokenUrl": "https://your.authserver.ext/v1/token",
			"scopes": {
				"some_scope": "Grants access to this API"
			}
		}
	},
	"security": [{
		"authToken": []
	}],
	"definitions": {},
	"tags": [{
		"name": "NginxCluster"
	}],
	"paths": {
		"/fund-slb-svc/api/v1/NginxCluster/": {
			"get": {
				"operationId": "NginxCluster.Cluster List",
				"summary": "nginx\u96c6\u7fa4\u5217\u8868",
				"description": "nginx\u96c6\u7fa4\u5217\u8868",
				"consumes": ["application/json"],
				"produces": ["application/json"],
				"tags": ["NginxCluster"],
				"parameters": [{
					"type": "string",
					"required": false,
					"in": "query",
					"name": "installation_path"
				}, {
					"type": "string",
					"required": false,
					"in": "query",
					"name": "type"
				}, {
					"type": "string",
					"required": false,
					"in": "query",
					"name": "version"
				}, {
					"type": "string",
					"required": false,
					"in": "query",
					"name": "name"
				}, {
					"type": "integer",
					"format": "int64",
					"required": false,
					"in": "query",
					"name": "id"
				}],
				"responses": {
					"200": {
						"schema": {
							"type": "object",
							"properties": {
								"msg": {
									"type": "string"
								},
								"code": {
									"type": "integer",
									"format": "int64"
								},
								"data": {
									"type": "object",
									"properties": {}
								}
							}
						},
						"description": "Success"
					}
				}
			},
			"post": {
				"operationId": "NginxCluster.Cluster List",
				"summary": "\u65b0\u589enginx\u96c6\u7fa4",
				"description": "\u65b0\u589enginx\u96c6\u7fa4",
				"consumes": ["application/json"],
				"produces": ["application/json"],
				"tags": ["NginxCluster"],
				"parameters": [{
					"schema": {
						"type": "object",
						"properties": {
							"name": {
								"type": "string"
							},
							"version": {
								"type": "string"
							},
							"type": {
								"type": "string"
							},
							"installation_path": {
								"type": "string"
							}
						}
					},
					"name": "body",
					"required": false,
					"in": "body"
				}],
				"responses": {
					"200": {
						"schema": {
							"type": "object",
							"properties": {
								"msg": {
									"type": "string"
								},
								"code": {
									"type": "integer",
									"format": "int64"
								},
								"data": {
									"type": "object",
									"properties": {}
								}
							}
						},
						"description": "Success"
					}
				}
			}
		},
		"/fund-slb-svc/api/v1/NginxCluster/{id}": {
			"get": {
				"operationId": "NginxCluster.NginxClusterGetOneController",
				"summary": "\u901a\u8fc7ID\u83b7\u53d6nginx\u96c6\u7fa4\u4fe1\u606f",
				"consumes": ["application/json"],
				"produces": ["application/json"],
				"tags": ["NginxCluster"],
				"parameters": [{
					"type": "integer",
					"format": "int64",
					"required": true,
					"in": "path",
					"name": "id"
				}, {
					"type": "integer",
					"format": "int64",
					"required": false,
					"in": "path",
					"name": "id"
				}],
				"responses": {
					"200": {
						"schema": {
							"type": "object",
							"properties": {
								"msg": {
									"type": "string"
								},
								"code": {
									"type": "integer",
									"format": "int64"
								},
								"data": {
									"type": "object",
									"properties": {}
								}
							}
						},
						"description": "Success"
					}
				}
			},
			"put": {
				"operationId": "NginxCluster.NginxClusterGetOneController",
				"summary": "\u901a\u8fc7ID\u66f4\u65b0nginx\u96c6\u7fa4\u4fe1\u606f",
				"consumes": ["application/json"],
				"produces": ["application/json"],
				"tags": ["NginxCluster"],
				"parameters": [{
					"type": "integer",
					"format": "int64",
					"required": true,
					"in": "path",
					"name": "id"
				}, {
					"type": "integer",
					"format": "int64",
					"required": false,
					"in": "path",
					"name": "id"
				}],
				"responses": {
					"200": {
						"schema": {
							"type": "object",
							"properties": {
								"msg": {
									"type": "string"
								},
								"code": {
									"type": "integer",
									"format": "int64"
								},
								"data": {
									"type": "object",
									"properties": {}
								}
							}
						},
						"description": "Success"
					}
				}
			},
			"delete": {
				"operationId": "NginxCluster.NginxClusterGetOneController",
				"summary": "\u901a\u8fc7ID\u5220\u9664nginx\u96c6\u7fa4\u4fe1\u606f",
				"consumes": ["application/json"],
				"produces": ["application/json"],
				"tags": ["NginxCluster"],
				"parameters": [{
					"type": "integer",
					"format": "int64",
					"required": true,
					"in": "path",
					"name": "id"
				}, {
					"type": "integer",
					"format": "int64",
					"required": false,
					"in": "path",
					"name": "id"
				}],
				"responses": {
					"200": {
						"schema": {
							"type": "object",
							"properties": {
								"msg": {
									"type": "string"
								},
								"code": {
									"type": "integer",
									"format": "int64"
								},
								"data": {
									"type": "object",
									"properties": {}
								}
							}
						},
						"description": "Success"
					}
				}
			}
		}
	}
}

@app.post("/user")
@doc.summary("Creates a user")
@doc.consumes({"user": { "name": str }}, location="body")
async def create_user(request):
    ...

class ModelsDemo:
    id = int
    name = str
    version = str
    type = str
    installation_path = str

blueprint = Blueprint('demo', '/demo')


@blueprint.get("/", strict_slashes=True)
@doc.summary("demo")
@doc.consumes(ModelsDemo, location="body")
async def ModelsDemoViews(request, *args, **kwargs):
    """
    List
    """
    pass

[2019-04-22 16:35:44 +0800] [44224] [ERROR] Exception occurred while handling uri: 'http://127.0.0.1:8080/swagger/swagger.json'
Traceback (most recent call last):
  File "E:\code\alter_svc\websocket-svc\lib\site-packages\sanic\app.py", line 915, in handle_request
    response = handler(request, *args, **kwargs)
  File "E:\local_git\fund-slb-svc\sanic_openapi\swagger.py", line 208, in spec
    return json(_spec)
  File "E:\code\alter_svc\websocket-svc\lib\site-packages\sanic\response.py", line 220, in json
    dumps(body, **kwargs),
  File "C:\Users\Administrator\AppData\Local\Programs\Python\Python37-32\lib\json\__init__.py", line 238, in dumps
    **kw).encode(obj)
  File "C:\Users\Administrator\AppData\Local\Programs\Python\Python37-32\lib\json\encoder.py", line 199, in encode
    chunks = self.iterencode(o, _one_shot=True)
  File "C:\Users\Administrator\AppData\Local\Programs\Python\Python37-32\lib\json\encoder.py", line 257, in iterencode
    return _iterencode(o, 0)
  File "C:\Users\Administrator\AppData\Local\Programs\Python\Python37-32\lib\json\encoder.py", line 179, in default
    raise TypeError(f'Object of type {o.__class__.__name__} '
TypeError: Object of type type is not JSON serializable

class OABuilding:
    floors = [OAFloor]
    # lat_lon = [doc.String()]
    state = doc.String("State")
    street = doc.String("Street")
    building_id = doc.String("Building ID")
    city = doc.String("City")
    province = doc.String("Province")
    zipcode = doc.String("Zipcode")
    phone = doc.String("Phone")
    notes = doc.String("Notes")
    name = doc.String("Building Name")


class OABuildingsResponse:
    data = doc.List(OABuilding, description="All buildings")

class OABuildingsResponse:
    data = [OABuilding]

@blueprint.get("/", strict_slashes=True)
@doc.consumes({ "user": { "name": str, "id": int }, "user1": { "name": str, "id": int }}, location="query", content_type='application/json')

app = sanic.Sanic(strict_slashes=True)

test_blueprint = sanic.Blueprint("test")

# no strict_slashes here
@test_blueprint.route("/test", methods=["GET"])
def test(request):
    return "Hello world"

app.blueprint(swagger_blueprint)
app.blueprint(test_blueprint)

app.static('/robots.txt', './static/robots.txt')

  @doc.summary("This is my view's getter")
  async def get(self, _):
    return response.json({'foo': []})

app.blueprint(openapi_blueprint, url_prefix='/api/openapi')
app.blueprint(swagger_blueprint, url_prefix='/api/swagger')

@blueprint.route('/spec.json')
def spec(request):
    return json(_spec)