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

Refactor of /api/map (and removing hardcoded documentation) #337

Merged
merged 3 commits into from
Oct 14, 2020
Merged

Refactor of /api/map (and removing hardcoded documentation) #337

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c820b9a
Removing RESTful API endpoint comments. Users should check wiki instead.
mattaereal Oct 11, 2020
f991cdc
Refactor of /api/map endpoint.
mattaereal Oct 11, 2020
eff7480
Merge branch 'dev' into dev
mattaereal Oct 13, 2020
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
29 changes: 10 additions & 19 deletions empire
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,13 +112,13 @@ def execute_db_query(conn, query, args=None):
cur.close()
return results


mattaereal marked this conversation as resolved.
Show resolved Hide resolved
####################################################################
#
# The Empire RESTful API.
# The Empire RESTful API. To see more information about it, check out the official wiki.
#
# Adapted from http://blog.miguelgrinberg.com/post/designing-a-restful-api-with-python-and-flask.
# Example code at https://gist.github.com/miguelgrinberg/5614326.
#
# Adapted from http://blog.miguelgrinberg.com/post/designing-a-restful-api-with-python-and-flask
# example code at https://gist.github.com/miguelgrinberg/5614326
#
# Verb URI Action
# ---- --- ------
Expand Down Expand Up @@ -185,6 +185,7 @@ def execute_db_query(conn, query, args=None):
# PUT http://localhost:1337/api/users/Y/updatepassword update password for user Y
#
####################################################################

def start_restful_api(empireMenu: MainMenu, suppress=False, username=None, password=None, port=1337):
"""
Kick off the RESTful API with the given parameters.
Expand Down Expand Up @@ -278,23 +279,13 @@ def start_restful_api(empireMenu: MainMenu, suppress=False, username=None, passw
"""
List all of the current registered API routes.
"""
import urllib.request as urllib
output = []
output = {}
for rule in app.url_map.iter_rules():

options = {}
for arg in rule.arguments:
options[arg] = "[{0}]".format(arg)

methods = ','.join(rule.methods)
url = url_for(rule.endpoint, **options)
line = urllib.parse.unquote("[ { '" + rule.endpoint + "': [ { 'methods': '" + methods + "', 'url': '" + url + "' } ] } ]")
output.append(line)

res = ''
for line in sorted(output):
res = res + '\r\n' + line
return jsonify({'Routes':res})
url = rule.rule
output.update({rule.endpoint: {'methods': methods, 'url': url}})

return jsonify({'Routes':output})

@app.route('/api/config', methods=['GET'])
def get_config():
Expand Down