def get_openapi_spec(self, data, needs_api_invoke, needs_rest_channels,
api_invoke_path):
data = bunchify(data)
channel_data = self.server.worker_store.request_dispatcher.url_data.channel_data
generator = OpenAPIGenerator(data, channel_data, needs_api_invoke,
needs_rest_channels, api_invoke_path)
return generator.generate()
def test_generate_open_api(self):
MyClass = deepcopy(MyService)
CySimpleIO.attach_sio(self.get_server_config(), MyClass)
service_store_services = {
'my.impl.name': {
'name': service_name,
'service_class': MyClass,
}
}
include = ['*']
exclude = []
query = ''
tags = 'public'
generator = Generator(service_store_services, sio_config, include, exclude, query, tags, needs_sio_desc=False)
info = generator.get_info()
info = bunchify(info)
channel_data = [{
'service_name': service_name,
'transport': URL_TYPE.PLAIN_HTTP,
'url_path': '/test/{phone_number}',
'match_target_compiled': _MatchTestCompiled()
}]
needs_api_invoke = True
needs_rest_channels = True
api_invoke_path = APISPEC.GENERIC_INVOKE_PATH
open_api_generator = OpenAPIGenerator(info, channel_data, needs_api_invoke, needs_rest_channels, api_invoke_path)
result = open_api_generator.generate()
result = yaml_load(result, FullLoader)
result = bunchify(result)
result_components = result.components # type: Bunch
result_info = result.info # type: Bunch
result_openapi = result.openapi # type: Bunch
result_paths = result.paths # type: Bunch
result_servers = result.servers # type: Bunch
localhost = result_servers[0]
self.assertEqual(localhost.url, 'http://localhost:11223')
self.assertEqual(result_info.title, 'API spec')
self.assertEqual(result_info.version, '1.0')
self.assertEqual(result_openapi, '3.0.2')
self.assertEqual(len(result_components.schemas), 2)
request_my_service_properties = result_components.schemas.request_my_service.properties
request_my_service_required = result_components.schemas.request_my_service.required
request_my_service_title = result_components.schemas.request_my_service.title
request_my_service_type = result_components.schemas.request_my_service.type
response_my_service_required = result_components.schemas.response_my_service.required
response_my_service_title = result_components.schemas.response_my_service.title
response_my_service_type = result_components.schemas.response_my_service.type
self.assertEqual(request_my_service_title, 'Request object for my.service')
self.assertEqual(response_my_service_title, 'Response object for my.service')
self.assertEqual(request_my_service_type, 'object')
self.assertEqual(response_my_service_type, 'object')
self.assertListEqual(sorted(request_my_service_required), ['input_req_customer_id', 'input_req_user_id'])
self.assertListEqual(sorted(response_my_service_required), ['output_req_address_id', 'output_req_address_name'])
self.assertEqual(request_my_service_properties.input_req_user_id.type, 'integer')
self.assertEqual(request_my_service_properties.input_req_user_id.format, 'int32')
self.assertEqual(request_my_service_properties.input_req_user_id.description,
'This is the first line.\nHere is another.\nAnd here are some more lines.')
self.assertEqual(request_my_service_properties.input_req_customer_id.type, 'integer')
self.assertEqual(request_my_service_properties.input_req_customer_id.format, 'int32')
self.assertEqual(request_my_service_properties.input_req_customer_id.description, '')
self.assertEqual(request_my_service_properties.input_opt_user_name.type, 'string')
self.assertEqual(request_my_service_properties.input_opt_user_name.format, 'string')
self.assertEqual(request_my_service_properties.input_opt_user_name.description, 'b111')
self.assertEqual(request_my_service_properties.input_opt_customer_name.type, 'string')
self.assertEqual(request_my_service_properties.input_opt_customer_name.format, 'string')
self.assertEqual(request_my_service_properties.input_opt_customer_name.description, '')
self.assertEqual(len(result_paths), 2)
for url_path in ['/test/{phone_number}', '/zato/api/invoke/my.service']:
my_service_path = result_paths[url_path] # type: Bunch
post = my_service_path.post
self.assertListEqual(post.consumes, ['application/json'])
self.assertEqual(post.operationId, 'post_{}'.format(fs_safe_name(url_path)))
self.assertTrue(post.requestBody.required)
self.assertEqual(
post.requestBody.content['application/json'].schema['$ref'], '#/components/schemas/request_my_service')
self.assertEqual(
post.responses['200'].content['application/json'].schema['$ref'], '#/components/schemas/response_my_service')
def get_openapi_spec(self, data):
data = bunchify(data)
return OpenAPIGenerator(
data, self.server.worker_store.request_dispatcher.url_data.
channel_data).generate()