Django 自動生成文件

老是忘 記錄下

coreapi

pip install coreapi

rest_framework = 
from rest_framework.documentation import include_docs_urls
urlpatterns += [
url('api/', include_docs_urls(title="介面測試平台api文件",
description="這個是介面平台的文件"
))]

django_rest_swagger

pip install django-rest-swagger

進入 seeting.py 新增 rest_framework_swagger 應用
from rest_framework_swagger.renderers import swaggeruirenderer, openapirenderer
schema_view = get_schema_view(title='介面文件', renderer_classes=[openapirenderer, swaggeruirenderer])
urlpatterns += [
url(r'swagger/', schema_view),
]

help_text="***x"

class userviewset(modelviewset):

"""list:
使用者列表
create: 建立使用者
update: 修改使用者屬性
delete:邏輯刪除使用者
retrieve:檢視某個使用者資訊
partial_update:修改使用者某個屬性
hh:測試action
"""queryset = user.objects.all()
serializer_class = userserializer
permission_classes = [allowany]
# schema = customschema()
@action(methods=['get'], detail=false)
def hh(self, reuqest):
# """
# 測試
# :param reuqest:
# :return:
# """
return jsonresponse()
class model(apiview):
def get(self, request):
"""測試 apiview
:param request:
:return:
"""return jsonresponse()

beego api自動生成文件

必須設定在 routers router.go 中，檔案的注釋，最頂部 apiversion 1.0.0 title mobile api description mobile has every tool to get any job done,so codename for the new mo...

使用Swagger自動生成文件

swagger 是乙個規範和完整的框架，用於生成 描述 呼叫和視覺化 restful 風格的 web 服務。springfox 的前身是 swagger springmvc，是乙個開源的 api doc 框架，可以將我們的 controller 的方法以文件的形式展現，基於 swagger。官網 第...

Sphinx python模組自動生成文件

安裝 pip install sphinx假設現在我們有乙個叫run.py的檔案，如下 run.py defrun name this is how we run param name name of people who runs print name,is running toctree max...