Add views for rendering a static API #23
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This implements three new views for rendering pages to static JSON files
using Wagtail's API module:
- ``PagesAPIDetailView`` renders detail pages at
``/api/pages/detail/{id}.json``
- ``PagesAPIListingView`` renders a full page listing at
``/api/pages/{page_num}.json``. Each page contains 20 results.
- ``TypedPagesAPIListingView`` renders a separate listing for each page
type at ``/api/pages/{app_label}.{model_name}/{page_num}.json``. Unlike
the standard listing view, this also includes all specific fields on that
page type.
All rendering is done through Wagtail's v2 API module so any
configuration the site has for that will be used by this static
renderer.
|
Great work @kaedroho ! I'll look at this during the weekend, keep you posted! |
|
Hi @robmoorman have you had a chance to look at this? Is there anything we can help with? |
|
@kaedroho can you please update the Configuration and Usage sections of the README to demonstrate how a developer would use the API view? |
|
He @tomdyson just need to run some extra testing on existing projects, code looks fine (some flake8 minor things though). Should be ready to merge very soon now. |
|
@kaedroho could you provide some tests as well? |
2 similar comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This implements three new views for rendering pages to static JSON files
using Wagtail's API module:
PagesAPIDetailViewrenders detail pages at/api/pages/detail/{id}.jsonPagesAPIListingViewrenders a full page listing at/api/pages/{page_num}.json. Each page contains 20 results.TypedPagesAPIListingViewrenders a separate listing for each page type at/api/pages/{app_label}.{model_name}/{page_num}.json. Unlike the standard listing view, this also includes all specific fields on that page type.All rendering is done through Wagtail's v2 API module so any configuration the site has for that will be used by this static renderer.