接口文档

接口文档

接口文档的编写是写给前端的人使用的，为了让前端人员能够查询到网页地址

接口文档的格式

• 请求地址
• 请求方式
• 支持的编码格式
• 请求参数(get,post参数)
• 返回的格式示例

编写接口文档的方式

编写接口文档的方式有：直接用word或者md编写、使用接口文档平台、项目自动生成接口文档

直接用word或者md编写

这种写法是很多公司使用的，比较简洁，方便，直接在word或者md上进行编写，不美观

使用接口文档平台编写

• 在接口文档平台录入(Yapi（百度开源的自己搭建）,第三方平台(收费)，自己开发接口文档平台)

  网址 https://www.showdoc.com.cn/item/index

• 如果不想花钱，没有能力开发，就使用开源的YAPI，

  网址：https://zhuanlan.zhihu.com/p/366025001

项目自动生成接口文档

REST framework可以自动帮助我们生成接口文档。

接口文档以网页的方式呈现。

自动接口文档能生成的是继承自APIView及其子类的视图。

• 需要安装第三方模块

  pip install coreapi
  

  REST framewrok生成接口文档需要coreapi库的支持。

• 路由中配置：

  from rest_framework.documentation import include_docs_urls
          urlpatterns = [
              path('docs/', include_docs_urls(title='站点页面标题'))
          ]
      
  

• 在视图类中加注释

  在类或函数下

  """ 注释内容 """

• 在配置文件中配置

  REST_FRAMEWORK = {
           'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
          }
  

• 访问接口文档网页

  浏览器访问 127.0.0.1:8000/docs/，即可看到自动生成的接口文档。

• 注意

  1.直接在视图类中写注释

  2.在序列化类上写help_text