[WIP] API Explorer back-end
Review Request #7904 — Created Jan. 24, 2016 and discarded
An API Explorer allows developers to make requests to the Web API from their browsers without having to download XML or JSON files. The API Explorer will display the response as syntax highlighted JSON in order to be understandable and facilitate development and understanding of the Web API.
In the future, users will be able to make POST, PUT and DELETE requests from a provided form and view documentation related to the resource.
This patch focuses on creating an HTML Encoder that will retrieve the payload and determine the resource being accessed.
Modifications to the way the Web API handles requests are also made to ensure that requests can also be made from a web browser.
Tested /api/users/<user_name> and /api/users/ which returned the correct information, in the proper format which displayed correctly in a web browser.
| Description | From | Last Updated |
|---|---|---|
|
Two blank lines between these. |
 brennie
|
|
|
This should have: from __future__ import unicode literals |
brennie
|
|
|
Docstring? |
brennie
|
|
|
Alphabetize. |
brennie
|
|
|
Docstring. |
brennie
|
|
|
Docstring. |
brennie
|
|
|
Docstring. |
brennie
|
|
|
Can we reforamt this as: return render_to_string( 'webapi/explorer.html', { 'payload': o, }) |
brennie
|
|
|
Single quotes for strings. |
brennie
|
|
|
Alphabetize these. |
brennie
|
|
|
Can you change all these to use single quotes? |
brennie
|
|
|
Please format this as: if (self.mimetype == 'text/plain' or is_mimetype_a(self.mimetype, 'application/json')): # ... |
brennie
|
|
|
Can you change this to all use single quotes? |
brennie
|
|
|
Single quotes. |
brennie
|
|
|
We already import json above. Lets just use json.dumps. |
brennie
|
|
|
So our import layout is as follows: from __future__ import unicode_literals # Always first. # Standard library imports. import json … |
brennie
|
|
|
'datetime' imported but unused |
 reviewbot
|
|
|
Col: 80 E501 line too long (86 > 79 characters) |
reviewbot
|
|
|
'Directive' imported but unused |
reviewbot
|
|
|
Col: 80 E501 line too long (110 > 79 characters) |
reviewbot
|
|
|
Col: 80 E501 line too long (110 > 79 characters) |
reviewbot
|
|
|
Col: 80 E501 line too long (113 > 79 characters) |
reviewbot
|
|
|
Col: 80 E501 line too long (113 > 79 characters) |
reviewbot
|
|
|
Col: 80 E501 line too long (110 > 79 characters) |
reviewbot
|
|
|
Col: 80 E501 line too long (110 > 79 characters) |
reviewbot
|
|
|
Col: 80 E501 line too long (113 > 79 characters) |
reviewbot
|
|
|
Col: 80 E501 line too long (113 > 79 characters) |
reviewbot
|
AD
Change Summary:
Added support for viewable responses from a web browser.
Description: |
|
||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Testing Done: |
|
||||||||||||||||||
Diff: |
Revision 2 (+30 -2) |
-
Tool: PEP8 Style Checker Processed Files: djblets/util/templatetags/djblets_webapi.py djblets/webapi/responses.py djblets/webapi/encoders.py Tool: Pyflakes Processed Files: djblets/util/templatetags/djblets_webapi.py djblets/webapi/responses.py djblets/webapi/encoders.py
-
-
-
djblets/util/templatetags/djblets_webapi.py (Diff revision 2) This should have:
from __future__ import unicode literals -
-
-
-
-
-
djblets/webapi/encoders.py (Diff revision 2) Can we reforamt this as:
return render_to_string( 'webapi/explorer.html', { 'payload': o, }) -
-
-
-
djblets/webapi/responses.py (Diff revision 2) Please format this as:
if (self.mimetype == 'text/plain' or is_mimetype_a(self.mimetype, 'application/json')): # ... -
-
-
Tool: Pyflakes Processed Files: djblets/util/templatetags/djblets_webapi.py djblets/webapi/responses.py djblets/webapi/encoders.py Tool: PEP8 Style Checker Processed Files: djblets/util/templatetags/djblets_webapi.py djblets/webapi/responses.py djblets/webapi/encoders.py
-
-
djblets/webapi/encoders.py (Diff revision 3) We already import
jsonabove. Lets just usejson.dumps. -
djblets/webapi/encoders.py (Diff revision 3) So our import layout is as follows:
from __future__ import unicode_literals # Always first. # Standard library imports. import json from xml.foo import bar # 3-rd party library imports. from django.conf import settings # ... from pygments import hilight # Our current project imports from djblets import foobarWe put full imports
import fooabove partial imports (from foo import bar),
AD
Change Summary:
-Updated encoder to strictly handle encoding the payload for HTML responses
-Added support for handling API responses in 'text/html' format.
-Added support for displaying the payload
-Removed template tag that is no longer used.
Diff: |
Revision 4 (+105 -19) |
|---|
-
Tool: Pyflakes Processed Files: djblets/util/templatetags/djblets_webapi.py djblets/webapi/resources/base.py djblets/webapi/responses.py djblets/webapi/encoders.py Tool: PEP8 Style Checker Processed Files: djblets/util/templatetags/djblets_webapi.py djblets/webapi/resources/base.py djblets/webapi/responses.py djblets/webapi/encoders.py
AD
Change Summary:
-Added support for passing resource fields to the template
-Added basic type handling for resource fields being passed to the template
-Updated HTML encoder to properly encode all resource types
Diff: |
Revision 5 (+134 -18) |
|---|
-
Tool: Pyflakes Processed Files: djblets/util/templatetags/djblets_webapi.py djblets/webapi/resources/base.py djblets/webapi/responses.py djblets/webapi/encoders.py Tool: PEP8 Style Checker Processed Files: djblets/util/templatetags/djblets_webapi.py djblets/webapi/resources/base.py djblets/webapi/responses.py djblets/webapi/encoders.py -
-
-
AD
Change Summary:
-Added support for differentiation between required and optional fields
-Added support for fields of different request types
-Removed extraneous imports
-Proper formatting
-Removed unused template tag
Diff: |
Revision 6 (+133 -19) |
|---|
-
Tool: Pyflakes Processed Files: djblets/webapi/resources/base.py djblets/webapi/responses.py djblets/webapi/encoders.py Tool: PEP8 Style Checker Processed Files: djblets/webapi/resources/base.py djblets/webapi/responses.py djblets/webapi/encoders.py -
-
-
-
-
Tool: Pyflakes Processed Files: djblets/webapi/resources/base.py djblets/webapi/responses.py djblets/webapi/encoders.py Tool: PEP8 Style Checker Processed Files: djblets/webapi/resources/base.py djblets/webapi/responses.py djblets/webapi/encoders.py -
-
-
-
AD
Change Summary:
-Added support for only displaying the payload response of a GET request made by the front-end
-Added support for handling resources that have no optional or required fields for GET requests
Diff: |
Revision 8 (+152 -19) |
|---|
-
Tool: Pyflakes Processed Files: djblets/webapi/resources/base.py djblets/webapi/responses.py djblets/webapi/encoders.py Tool: PEP8 Style Checker Processed Files: djblets/webapi/resources/base.py djblets/webapi/responses.py djblets/webapi/encoders.py
AD
Change Summary:
- Added support for indicating if an HTTP response is wrapped or not
Diff: |
Revision 9 (+156 -19) |
|---|
-
Tool: Pyflakes Processed Files: djblets/webapi/resources/base.py djblets/webapi/responses.py djblets/webapi/encoders.py Tool: PEP8 Style Checker Processed Files: djblets/webapi/resources/base.py djblets/webapi/responses.py djblets/webapi/encoders.py
AD
Change Summary:
- Updated how HTML request types are handled to the API
- Updated how standard http response types are handled
Diff: |
Revision 10 (+176 -25) |
|---|
-
Tool: Pyflakes Processed Files: djblets/webapi/resources/base.py djblets/webapi/responses.py djblets/webapi/encoders.py Tool: PEP8 Style Checker Processed Files: djblets/webapi/resources/base.py djblets/webapi/responses.py djblets/webapi/encoders.py
AD
Change Summary:
- Updated how HTML request types are handled to the API
- Updated how standard HTTP response types are handled
- Updated how API Explorer template is rendered
- Refactored code
Description: |
|
|---|
Tool: Pyflakes Processed Files: djblets/webapi/responses.py djblets/webapi/encoders.py Tool: PEP8 Style Checker Processed Files: djblets/webapi/responses.py djblets/webapi/encoders.py