Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support openapi 'servers' #216

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Support openapi 'servers' #216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e873b8
feat: Support for 'servers' in openapi
aVolpe Apr 24, 2023
030daed
feat: Add test to check load of yml file
aVolpe Apr 24, 2023
3feb279
feat: Add support for open api servers
aVolpe Apr 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions http_prompt/context/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
from http_prompt.tree import Node
from urllib.parse import urlparse


class Context(object):
Expand All @@ -15,15 +16,28 @@ def __init__(self, url=None, spec=None):
# Create a tree for supporting API spec and ls command
self.root = Node('root')
if spec:
is_open_api = 'openapi' in spec

if not self.url:
schemes = spec.get('schemes')
scheme = schemes[0] if schemes else 'https'
self.url = (scheme + '://' +
spec.get('host', 'http://localhost:8000') +
spec.get('basePath', ''))
if is_open_api:
# In open api, the schemes are in the 'server' element,
self.url = spec.get('servers', [{'url': 'http://localhost:8000'}])[0].get('url')
else:
schemes = spec.get('schemes')
scheme = schemes[0] if schemes else 'https'
self.url = (scheme + '://' +
spec.get('host', 'http://localhost:8000') +
spec.get('basePath', ''))

# in open api, there is no 'basePath', we should extract that from the url
if is_open_api:
server = spec.get('servers', [{'url': 'http://localhost:8000'}])[0].get('url')
base_path_tokens = list(filter(lambda s: s,
urlparse(server).path.split('/')))
else:
base_path_tokens = list(filter(lambda s: s,
spec.get('basePath', '').split('/')))

base_path_tokens = list(filter(lambda s: s,
spec.get('basePath', '').split('/')))
paths = spec.get('paths')
if paths:
for path in paths:
Expand Down
49 changes: 44 additions & 5 deletions tests/test_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,45 @@ def test_spec_from_local(self):
self.assertEqual(set([n.name for n in context.root.children]),
set(['users', 'orgs']))

def test_spec_from_local_yml(self):
spec_filepath = self.make_tempfile("""
paths:
/users:
get:
description:
/orgs:
get:
description:
""")
result, context = run_and_exit(['example.com', "--spec",
spec_filepath])
self.assertEqual(result.exit_code, 0)
self.assertEqual(context.url, 'http://example.com')
self.assertEqual(set([n.name for n in context.root.children]),
set(['users', 'orgs']))

def test_spec_from_local_yml_openapi(self):
spec_filepath = self.make_tempfile("""
openapi: "3.0.0"
servers:
- url: https://localhost:8080/
paths:
/api/users:
get:
description:
/api/orgs:
get:
description:
""")
result, context = run_and_exit(['example.com/api', "--spec",
spec_filepath])
self.assertEqual(result.exit_code, 0)
self.assertEqual(context.url, 'http://example.com/api')
self.assertEqual(set([n.name for n in context.root.children]),
set(['api']))
self.assertEqual(set([n.name for n in context.root.ls('api')]),
set(['users', 'orgs']))

def test_spec_basePath(self):
spec_filepath = self.make_tempfile(json.dumps({
'basePath': '/api/v1',
Expand Down Expand Up @@ -198,16 +237,16 @@ def test_spec_from_http(self):

def test_spec_from_http_only(self):
spec_url = (
'https://api.apis.guru/v2/specs/medium.com/1.0.0/swagger.json')
'https://api.apis.guru/v2/specs/medium.com/1.0/openapi.json')
result, context = run_and_exit(['--spec', spec_url])
self.assertEqual(result.exit_code, 0)
self.assertEqual(context.url, 'https://api.medium.com/v1')
self.assertEqual(context.url, 'https://medium2.p.rapidapi.com')

lv1_names = set([node.name for node in context.root.ls()])
lv2_names = set([node.name for node in context.root.ls('v1')])
lv2_names = set([node.name for node in context.root.ls('article')])

self.assertEqual(lv1_names, set(['v1']))
self.assertEqual(lv2_names, set(['me', 'publications', 'users']))
self.assertEqual(lv1_names, set(['/', 'topfeeds', 'related_tags', 'user', 'article', 'list', 'latestposts', 'search', 'top_writer', 'publication']))
self.assertEqual(lv2_names, set(['{article_id}']))

def test_spec_with_trailing_slash(self):
spec_filepath = self.make_tempfile(json.dumps({
Expand Down