Gjert Ingar Gjersund
2018-08-02 09:55:50 UTC
I'm currently working on my API documentation and I have come across a few
problems.
1. My API is not running from the root path (e.g. www.example.com) but
rather from a subpath (e.g. www.example.com/api/). Is there any way to
specify a prefix for the built-in documentation that is supplied? If I
decide to prefix every endpoint with `api` my docs view will put all my
endpoints into the same dropdown window under `api`. However, if I dont do
this, the built-in interactive parts of the documentation doesn't fetch
data from the correct urls.
2. Are there any good documentation regarding how to use descriptions for
path, query parameters using docstring? Also, what type of docstring
formatting does the built-in version use?
problems.
1. My API is not running from the root path (e.g. www.example.com) but
rather from a subpath (e.g. www.example.com/api/). Is there any way to
specify a prefix for the built-in documentation that is supplied? If I
decide to prefix every endpoint with `api` my docs view will put all my
endpoints into the same dropdown window under `api`. However, if I dont do
this, the built-in interactive parts of the documentation doesn't fetch
data from the correct urls.
2. Are there any good documentation regarding how to use descriptions for
path, query parameters using docstring? Also, what type of docstring
formatting does the built-in version use?
--
You received this message because you are subscribed to the Google Groups "Django REST framework" group.
To unsubscribe from this group and stop receiving emails from it, send an email to django-rest-framework+***@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
You received this message because you are subscribed to the Google Groups "Django REST framework" group.
To unsubscribe from this group and stop receiving emails from it, send an email to django-rest-framework+***@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.