mirror of
https://github.com/peeringdb/peeringdb.git
synced 2024-05-11 05:55:09 +00:00
c21130eed9
* module docstrings * db schema graph * dev docs first pass * dev docs pass 2 * add generated notification to top of generated docs files * linting * regen docs Co-authored-by: Stefan Pratter <stefan@20c.com> Co-authored-by: Sunshine Buchholz <sunshine@20c.com>
62 lines
1.0 KiB
Markdown
62 lines
1.0 KiB
Markdown
Generated from renderers.py on 2021-10-15 07:56:57.376975
|
|
|
|
# peeringdb_server.renderers
|
|
|
|
REST API renderer.
|
|
|
|
Ensure valid json output of the REST API.
|
|
|
|
# Classes
|
|
---
|
|
|
|
## JSONEncoder
|
|
|
|
```
|
|
JSONEncoder(rest_framework.utils.encoders.JSONEncoder)
|
|
```
|
|
|
|
Define json encoder to be able to encode
|
|
datatime and django countryfields.
|
|
|
|
Make the munge renderer use this encoder to encode json. This approach
|
|
may need to be tidied up a bit.
|
|
|
|
|
|
### Methods
|
|
|
|
#### default
|
|
`def default(self, obj)`
|
|
|
|
Default JSON serializer.
|
|
|
|
---
|
|
|
|
## MetaJSONRenderer
|
|
|
|
```
|
|
MetaJSONRenderer(peeringdb_server.renderers.MungeRenderer)
|
|
```
|
|
|
|
Renderer which serializes to JSON.
|
|
Does *not* apply JSON's character escaping for non-ascii characters.
|
|
|
|
|
|
### Methods
|
|
|
|
#### render
|
|
`def render(self, data, accepted_media_type=None, renderer_context=None)`
|
|
|
|
Tweak output rendering and pass to parent.
|
|
|
|
---
|
|
|
|
## MungeRenderer
|
|
|
|
```
|
|
MungeRenderer(rest_framework.renderers.BaseRenderer)
|
|
```
|
|
|
|
All renderers should extend this class, setting the `media_type`
|
|
and `format` attributes, and override the `.render()` method.
|
|
|