Summary

[WIP] API Explorer back-end

Review Request #7904 — Created Jan. 24, 2016 and discarded Sept. 24, 2017, 7:31 a.m.

Information

Owner

adilally

Repository

Djblets

Branch

master

Bugs

Depends On

Blocks

7905

Reviewers

Groups

djblets

People

Description

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.

Testing Done

Tested /api/users/<user_name> and /api/users/ which returned the correct information, in the proper format which displayed correctly in a web browser.

Issues

Description	From	Last Updated
Two blank lines between these.	brennie	Feb. 9, 2016, 3:17 p.m.
This should have: from __future__ import unicode literals	brennie	Feb. 9, 2016, 3:17 p.m.
Docstring?	brennie	Feb. 9, 2016, 3:17 p.m.
Alphabetize.	brennie	Feb. 9, 2016, 3:21 p.m.
Docstring.	brennie	Feb. 9, 2016, 3:21 p.m.
Docstring.	brennie	Jan. 31, 2016, 2:30 p.m.
Docstring.	brennie	Feb. 10, 2016, 9:46 a.m.
Can we reforamt this as: return render_to_string( 'webapi/explorer.html', { 'payload': o, })	brennie	Feb. 9, 2016, 3:24 p.m.
Single quotes for strings.	brennie	Feb. 9, 2016, 3:24 p.m.
Alphabetize these.	brennie	Feb. 9, 2016, 3:25 p.m.
Can you change all these to use single quotes?	brennie	Feb. 9, 2016, 3:30 p.m.
Please format this as: if (self.mimetype == 'text/plain' or is_mimetype_a(self.mimetype, 'application/json')): # ...	brennie	Feb. 9, 2016, 3:26 p.m.
Can you change this to all use single quotes?	brennie	Feb. 9, 2016, 3:30 p.m.
Single quotes.	brennie	Feb. 9, 2016, 3:26 p.m.
We already import json above. Lets just use json.dumps.	brennie	Feb. 10, 2016, 2:12 p.m.
So our import layout is as follows: from __future__ import unicode_literals # Always first. # Standard library imports. import json …	brennie	Feb. 10, 2016, 2:12 p.m.
'datetime' imported but unused	reviewbot	Feb. 28, 2016, 4:51 p.m.
Col: 80 E501 line too long (86 > 79 characters)	reviewbot	Feb. 28, 2016, 4:51 p.m.
'Directive' imported but unused	reviewbot	Feb. 28, 2016, 4:51 p.m.
Col: 80 E501 line too long (110 > 79 characters)	reviewbot	March 13, 2016, 6:07 p.m.
Col: 80 E501 line too long (110 > 79 characters)	reviewbot	March 13, 2016, 6:07 p.m.
Col: 80 E501 line too long (113 > 79 characters)	reviewbot	March 13, 2016, 6:07 p.m.
Col: 80 E501 line too long (113 > 79 characters)	reviewbot	March 13, 2016, 6:07 p.m.
Col: 80 E501 line too long (110 > 79 characters)	reviewbot	March 20, 2016, 6:21 p.m.
Col: 80 E501 line too long (110 > 79 characters)	reviewbot	March 20, 2016, 6:21 p.m.
Col: 80 E501 line too long (113 > 79 characters)	reviewbot	March 20, 2016, 6:21 p.m.
Col: 80 E501 line too long (113 > 79 characters)	reviewbot	March 20, 2016, 6:21 p.m.

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

Description:: -Added support for api requests made by web browsers to return HTML.
-
-
-Added initial template that displays the api request payload, unformatted.

Depends On:: ~~7905 - [WIP] API Explorer template front-end~~

Summary:: [WIP] Added API Explorer to Web API.
[WIP] Added HTML encoder to Web API.

Change Summary:

Added support for viewable responses from a web browser.

Description:

~		-Added support for api requests made by web browsers to return HTML.
	~	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.

Testing Done:

~		Tested /api/users/<user_name> with and without a user specified.
	~	Tested /api/users/<user_name> and /api/users/ which returned the correct information, in the proper format which displayed correctly in a web browser.
-
-		Unit tests succeeded.

Diff:

Revision 2 (+30 -2)

Show changes

	djblets/util/templatetags/djblets_webapi.py
	djblets/webapi/encoders.py
	djblets/webapi/responses.py

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

Fix it!

djblets/util/templatetags/djblets_webapi.py (Diff revision 2)
The issue has been dropped. Show all issues
```
Two blank lines between these.
```

djblets/util/templatetags/djblets_webapi.py (Diff revision 2)

The issue has been dropped. Show all issues

This should have:

from __future__ import unicode literals

djblets/util/templatetags/djblets_webapi.py (Diff revision 2)
The issue has been dropped. Show all issues
```
Docstring?
```
1. AD
  
  adilally Feb. 9, 2016, 3:27 p.m.
  For reference: dblets_webapi.py is going to be removed as it is no longer used.
djblets/webapi/encoders.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Alphabetize.
```
djblets/webapi/encoders.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Docstring.
```
djblets/webapi/encoders.py (Diff revision 2)
An issue was opened. Show all issues
```
Docstring.
```
djblets/webapi/encoders.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Docstring.
```

djblets/webapi/encoders.py (Diff revision 2)

The issue has been resolved. Show all issues

Can we reforamt this as:

return render_to_string(
    'webapi/explorer.html',
    {
        'payload': o,
    })

djblets/webapi/encoders.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Single quotes for strings.
```
djblets/webapi/responses.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Alphabetize these.
```
djblets/webapi/responses.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Can you change all these to use single quotes?
```

djblets/webapi/responses.py (Diff revision 2)

The issue has been resolved. Show all issues

Please format this as:

if (self.mimetype == 'text/plain' or
    is_mimetype_a(self.mimetype, 'application/json')):
    # ...

djblets/webapi/responses.py (Diff revision 2)

The issue has been resolved. Show all issues

Can you change this to all use single quotes?

djblets/webapi/responses.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Single quotes.
```

Depends On:: ~~7905 - [WIP] API Explorer template front-end~~

Change Summary:

Added functionality, will need to resolve issues.

Diff:

Revision 3 (+41 -2)

Show changes

	djblets/util/templatetags/djblets_webapi.py
	djblets/webapi/encoders.py
	djblets/webapi/responses.py

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)
The issue has been resolved. Show all issues
```
We already import json above. Lets just use json.dumps.
```

djblets/webapi/encoders.py (Diff revision 3)

The issue has been resolved. Show all issues

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 foobar


We put full imports import foo above partial imports (from foo import bar),

AD

adilally Feb. 10, 2016, 2:12 p.m.
```
Ohhh, that makes sense thanks.
```

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)

Show changes

	djblets/util/templatetags/djblets_webapi.py
	djblets/webapi/encoders.py
	djblets/webapi/responses.py
	djblets/webapi/resources/base.py

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

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)

Show changes

	djblets/util/templatetags/djblets_webapi.py
	djblets/webapi/encoders.py
	djblets/webapi/responses.py
	djblets/webapi/resources/base.py

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

djblets/webapi/encoders.py (Diff revision 5)
The issue has been resolved. Show all issues
```
 'datetime' imported but unused
```
djblets/webapi/encoders.py (Diff revision 5)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (86 > 79 characters)
```
djblets/webapi/resources/base.py (Diff revision 5)
The issue has been resolved. Show all issues
```
 'Directive' imported but unused
```

Summary:: [WIP] Added HTML encoder to Web API.
[WIP] API Explorer back-end

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)

Show changes

	djblets/webapi/encoders.py
	djblets/webapi/responses.py
	djblets/webapi/resources/base.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

djblets/webapi/resources/base.py (Diff revision 6)
The issue has been dropped. Show all issues
```
Col: 80
 E501 line too long (110 > 79 characters)
```
djblets/webapi/resources/base.py (Diff revision 6)
The issue has been dropped. Show all issues
```
Col: 80
 E501 line too long (110 > 79 characters)
```
djblets/webapi/resources/base.py (Diff revision 6)
The issue has been dropped. Show all issues
```
Col: 80
 E501 line too long (113 > 79 characters)
```
djblets/webapi/resources/base.py (Diff revision 6)
The issue has been dropped. Show all issues
```
Col: 80
 E501 line too long (113 > 79 characters)
```

Change Summary:

Added support for request context in template.

Diff:

Revision 7 (+134 -19)

Show changes

	djblets/webapi/encoders.py
	djblets/webapi/responses.py
	djblets/webapi/resources/base.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

djblets/webapi/resources/base.py (Diff revision 7)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (110 > 79 characters)
```
djblets/webapi/resources/base.py (Diff revision 7)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (110 > 79 characters)
```
djblets/webapi/resources/base.py (Diff revision 7)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (113 > 79 characters)
```
djblets/webapi/resources/base.py (Diff revision 7)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (113 > 79 characters)
```

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)

Show changes

	djblets/webapi/encoders.py
	djblets/webapi/responses.py
	djblets/webapi/resources/base.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

Change Summary:


Added support for indicating if an HTTP response is wrapped or not

Diff:

Revision 9 (+156 -19)

Show changes

	djblets/webapi/encoders.py
	djblets/webapi/responses.py
	djblets/webapi/resources/base.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

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)

Show changes

	djblets/webapi/encoders.py
	djblets/webapi/responses.py
	djblets/webapi/resources/base.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

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:: 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.

Status:: Discarded

		-Added support for api requests made by web browsers to return HTML.
-
-		-Added initial template that displays the api request payload, unformatted.