在django项目中实现RAML文档

时间:2017-07-18 17:52:05

标签: python django django-rest-framework api-design raml

我已经为django设置了RAML。它读取我的网址并在我的localhost中显示文档页面。现在我需要编写RAML代码用于文档,其中我定义了所有请求和响应。我不知道在我的django项目中在哪里写RAML代码。

urls.py

from django.conf.urls import url, include
from django.contrib import admin
from users import views
from rest_framework.schemas import get_schema_view
from rest_framework_raml.renderers import RAMLRenderer, RAMLDocsRenderer

schema_view = get_schema_view(
    title='Example API',
    renderer_classes=[RAMLRenderer, RAMLDocsRenderer])


urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^api/v1/users/emailsignup/', views.SignUp.as_view()),
    url(r'^api/v1/users/userget/', views.UserDetail.as_view()),
    url(r'^api/v1/users/emailsignin/', views.SignIn.as_view()),
    url(r'^api/v1/users/emailsignout/', views.SignOut.as_view()),
    url(r'^raml/$', schema_view),
]

我需要知道在项目中编写raml代码的位置以及如何提供其URL

0 个答案:

没有答案