problem with customize code samples in api documentation
Multi tool use
I am trying to add swift code samples to the auto-generated api documentation in my django-rest-framework project.
The docs say I must subclass DocumentationRenderer and add the languages I want as well as create the templates for them. But it does not tell me what to do with the subclassed Renderer.
from rest_framework.renderers import DocumentationRenderer
class CustomRenderer(DocumentationRenderer):
languages = ['ruby', 'go']
So I created "CustomRenderer" in my file under core/serializers.py great, now what? Where do I reference this class so I can actually apply it?
https://www.django-rest-framework.org/topics/documenting-your-api/#customising-code-samples
django django-rest-framework
asked Dec 28 '18 at 3:19
ron
865
add a comment |
I am trying to add swift code samples to the auto-generated api documentation in my django-rest-framework project.
The docs say I must subclass DocumentationRenderer and add the languages I want as well as create the templates for them. But it does not tell me what to do with the subclassed Renderer.
from rest_framework.renderers import DocumentationRenderer
class CustomRenderer(DocumentationRenderer):
languages = ['ruby', 'go']
So I created "CustomRenderer" in my file under core/serializers.py great, now what? Where do I reference this class so I can actually apply it?
https://www.django-rest-framework.org/topics/documenting-your-api/#customising-code-samples
django django-rest-framework
asked Dec 28 '18 at 3:19
ron
865
add a comment |
I am trying to add swift code samples to the auto-generated api documentation in my django-rest-framework project.
The docs say I must subclass DocumentationRenderer and add the languages I want as well as create the templates for them. But it does not tell me what to do with the subclassed Renderer.
from rest_framework.renderers import DocumentationRenderer
class CustomRenderer(DocumentationRenderer):
languages = ['ruby', 'go']
So I created "CustomRenderer" in my file under core/serializers.py great, now what? Where do I reference this class so I can actually apply it?
https://www.django-rest-framework.org/topics/documenting-your-api/#customising-code-samples
django django-rest-framework
asked Dec 28 '18 at 3:19
ron
865
I am trying to add swift code samples to the auto-generated api documentation in my django-rest-framework project.
The docs say I must subclass DocumentationRenderer and add the languages I want as well as create the templates for them. But it does not tell me what to do with the subclassed Renderer.
from rest_framework.renderers import DocumentationRenderer
class CustomRenderer(DocumentationRenderer):
languages = ['ruby', 'go']
So I created "CustomRenderer" in my file under core/serializers.py great, now what? Where do I reference this class so I can actually apply it?
https://www.django-rest-framework.org/topics/documenting-your-api/#customising-code-samples
django django-rest-framework
django django-rest-framework
asked Dec 28 '18 at 3:19
ron
865
asked Dec 28 '18 at 3:19
ron
865
asked Dec 28 '18 at 3:19
ron
865
asked Dec 28 '18 at 3:19
ron
865
asked Dec 28 '18 at 3:19
ron
865
865
add a comment |
add a comment |
1 Answer
1
active
oldest
votes
The include_docs_urls() function takes an optional argument, renderer_classes which is None by default.
You can check the source code of include_docs_urls() here...
So, Your CustomRenderer class can be provide through the include_docs_urls() in urls.py as,
from rest_framework.documentation import include_docs_urls
urlpatterns = [
...
url(r'^docs/', include_docs_urls(title='My API title',renderer_classes=CustomRenderer))
]answered Dec 28 '18 at 3:44
JPG
13.3k2831
add a comment |
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53953297%2fproblem-with-customize-code-samples-in-api-documentation%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
The include_docs_urls() function takes an optional argument, renderer_classes which is None by default.
You can check the source code of include_docs_urls() here...
So, Your CustomRenderer class can be provide through the include_docs_urls() in urls.py as,
from rest_framework.documentation import include_docs_urls
urlpatterns = [
...
url(r'^docs/', include_docs_urls(title='My API title',renderer_classes=CustomRenderer))
]answered Dec 28 '18 at 3:44
JPG
13.3k2831
add a comment |
The include_docs_urls() function takes an optional argument, renderer_classes which is None by default.
You can check the source code of include_docs_urls() here...
So, Your CustomRenderer class can be provide through the include_docs_urls() in urls.py as,
from rest_framework.documentation import include_docs_urls
urlpatterns = [
...
url(r'^docs/', include_docs_urls(title='My API title',renderer_classes=CustomRenderer))
]answered Dec 28 '18 at 3:44
JPG
13.3k2831
add a comment |
The include_docs_urls() function takes an optional argument, renderer_classes which is None by default.
You can check the source code of include_docs_urls() here...
So, Your CustomRenderer class can be provide through the include_docs_urls() in urls.py as,
from rest_framework.documentation import include_docs_urls
urlpatterns = [
...
url(r'^docs/', include_docs_urls(title='My API title',renderer_classes=CustomRenderer))
]answered Dec 28 '18 at 3:44
JPG
13.3k2831
The include_docs_urls() function takes an optional argument, renderer_classes which is None by default.
You can check the source code of include_docs_urls() here...
So, Your CustomRenderer class can be provide through the include_docs_urls() in urls.py as,
from rest_framework.documentation import include_docs_urls
urlpatterns = [
...
url(r'^docs/', include_docs_urls(title='My API title',renderer_classes=CustomRenderer))
]answered Dec 28 '18 at 3:44
JPG
13.3k2831
answered Dec 28 '18 at 3:44
JPG
13.3k2831
answered Dec 28 '18 at 3:44
JPG
13.3k2831
answered Dec 28 '18 at 3:44
JPG
13.3k2831
13.3k2831
add a comment |
add a comment |
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Some of your past answers have not been well-received, and you're in danger of being blocked from answering.
Please pay close attention to the following guidance:
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53953297%2fproblem-with-customize-code-samples-in-api-documentation%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
xHY,9c PFi9dMmETJ21H9o,i6prvrvOhLz43ZTQkTvp,N9scU7wCYB8W
