Render API Blueprints on-the-fly using Django templates
Project description
django-apiblueprint-view
Render API Blueprints on-the-fly using Django templates
Installation
-
pip install django-apiblueprint-view
-
Add to
INSTALLED_APPS
in django settings:
INSTALLED_APPS = [
...
'apiblueprint_view',
]
Usage
from apiblueprint_view.views import ApiBlueprintView
urlpatterns = [
url(r'^docs/$', ApiBlueprintView.as_view(blueprint='/path/to/blueprint.apibp')),
]
Styling
Custom HTML Template
Define a custom base template. It must include the tag
{% include 'api_docs/docs_parent.html' %}
Pass it into ApiBlueprintView.as_view()
as a parameter.
from apiblueprint_view.views import ApiBlueprintView
urlpatterns = [
url(r'^docs/$', ApiBlueprintView.as_view(
blueprint='/path/to/blueprint.apibp',
template_name='my_base_template.html'
)),
]
Custom CSS
ApiBlueprintView.as_view()
may accept a styles
dictionary describing custom CSS classes which should be attached to rendered HTML tags. For example:
from apiblueprint_view.views import ApiBlueprintView
urlpatterns = [
url(r'^docs/$', ApiBlueprintView.as_view(
blueprint='/path/to/blueprint.apibp',
template_name='my_base_template.html',
styles={
'action': {'class': 'foo bar'},
'method': {'class': 'baz'}
}
)),
]
The following keys are valid. All keys are optional:
'action'
: Container<div>
for an API action'action_transaction'
: Container<div>
for a HTTP transaction (request and response)'action_request'
: Container<div>
for a HTTP request'action_response'
: Container<div>
for a HTTP response'action_schema'
: Container<div>
for a HTTP request or response schema'action_headers'
: Container<div>
for HTTP request or response headers'action_body'
: Container<div>
for a HTTP request or response body'action_example'
: Container<div>
for an API action example URL'description'
: Container<div>
for some text describing an action, resource, request, response, etc'parameters'
: Container<div>
for a list of parameters'method'
: Generic<span>
containing an HTTP method'method_CONNECT'
:<span>
containing the textCONNECT
'method_DELETE'
:<span>
containing the textDELETE
'method_GET'
:<span>
containing the textGET
'method_HEAD'
:<span>
containing the textHEAD
'method_OPTIONS'
:<span>
containing the textOPTIONS
'method_PATCH'
:<span>
containing the textPATCH
'method_POST'
:<span>
containing the textPOST
'method_PUT'
:<span>
containing the textPUT
'method_TRACE'
:<span>
containing the textTRACE
'resource'
: Container<div>
for an API resource'resource_group'
: Container<div>
for an API resource group
Highlight.js can be used to add syntax highlighting
Including Files
You can include other files in your blueprint by using an include directive with a path to the included file relative to the current file's directory. Included files can include other files, so be careful of circular references.
<!-- include(filename.md) -->
This syntax is not a part of the API Blueprint spec, but is also supported in some other tools e.g: aglio.
The include directive has the potential to introduce remote file inclusion or directory traversal vulnerabilities if your application renders user-supplied content. There are a couple of settings to help mitigate this. Set APIBP_PROCESS_INCLUDES = False
in your django settings to completely ignore include directives (the default is True
). There is also a whitelist of allowed file types to include. The default whitelist is ['.md', '.apibp', '.json']
but this can be overridden by setting APIBP_INCLUDE_WHITELIST
to a list of allowed extensions in your django settings.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for django_apiblueprint_view-2.2.1-py3-none-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc332ad6d616548b934b390216b556769ae9327810c523c0edd0a00ca93642e9 |
|
MD5 | 20f105e75ea274e072ba1d87cb2d0af6 |
|
BLAKE2b-256 | 23985601d2747fd9219da0fef55ee92d92bf4b4fa0f54fbe80d8293fd38914a2 |
Hashes for django_apiblueprint_view-2.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c66d958d29108e0c99ebd1a7aa98861512d5cd8f6574d926da7cdef163381937 |
|
MD5 | a13c091880a9815fa0035409f9b2e2d0 |
|
BLAKE2b-256 | d5fc75e9f1c9e712b64b08f1c4e1e40fd4931de38e03ba7fbaa32927851ac31c |